loopbackio / loopbackio/loopback.io

Missing documentation of DefaultCrudRepository

Open
#1,781 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
276
Forks
382
Avg merge
6h 17m
Merged PRs (30d)
18

Description

## URL of the page

[https://loopback.io/doc/en/lb4/](https://loopback.io/doc/en/lb4/)

## Nature of the issue

There is no API documentation for DefaultCrudRepository which is a key class.
The only place where it can be found is:
https://marioestradarosa.github.io/loopback.io/doc/en/lb4/apidocs.repository.defaultcrudrepository.html

## Expected behavior

I expect to find the API documentation by searching for DefaultCrudRepository or by browsing to:
[https://loopback.io/doc/en/lb4/apidocs.index.html](https://loopback.io/doc/en/lb4/apidocs.index.html)
but here the entire [@loopback/repository](https://loopback.io/doc/en/lb4/apidocs.repository.html)
is missing.

## Actual behavior

When I search DefaultCrudRepository it finds 5 references but not the API specification.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the LB4 API documentation index and the @loopback/repository page linked in the issue, then verify how DefaultCrudRepository is represented in the published docs. Done means the DefaultCrudRepository API specification and the rest of @loopback/repository are reachable from the index and searchable on the documentation site.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.