Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[Epic] Make sure documentation is up-to-date (2019Q2 Edition) #1951

Closed
dhmlau opened this issue Oct 31, 2018 · 4 comments
Closed

[Epic] Make sure documentation is up-to-date (2019Q2 Edition) #1951

dhmlau opened this issue Oct 31, 2018 · 4 comments

Comments

@dhmlau
Copy link
Member

dhmlau commented Oct 31, 2018

Description / Steps to reproduce / Feature proposal

Make sure:

  • documentation is up-to-date
    • code exists in documentation is runnable
  • apidoc is up-to-date and usable
@loredanacirstea
Copy link

loredanacirstea commented Nov 5, 2018

At the end of this section: https://loopback.io/doc/en/lb4/HasMany-relation.html#configuring-a-hasmany-relation there are links for create, find, delete, patch - e.g. https://apidocs.strongloop.com/@loopback%2fdocs/repository.html#HasManyRepository.prototype.create.

None of them work anymore (they worked ~2 weeks ago). I did not find the HasManyRepository documentation at all in https://apidocs.strongloop.com/@loopback%2fdocs/repository.html
Has the location changed?

Maybe docs related - I have seen this entry in the changelog: mark HasManyRepository as a readonly property (39227eb) and the subsequent doc change. Is HasManyRepository now only readonly? Asking because I have some issues now with using delete on a _createHasManyRepositoryFactoryFor - though create works, so it is possibly another issue, but I'm mentioning it in case the docs can be made more clearer.

@dhmlau
Copy link
Member Author

dhmlau commented Nov 6, 2018

@bajtos , it might be related to the clean up work you've done recently on hasMany?

@dhmlau dhmlau mentioned this issue Nov 20, 2018
20 tasks
@bajtos
Copy link
Member

bajtos commented Dec 4, 2018

it might be related to the clean up work you've done recently

Ah, looks like I forgot to list the newly added files in https://github.com/strongloop/loopback-next/blob/master/packages/repository/docs.json

@loredanacirstea would you like to contribute the fix yourself? Compare the list of TS files listed in docs.json with the actual files inside packages/repository/src and add those that are missing.

@bajtos bajtos changed the title [Epic] Make sure document is up-to-date [Epic] Make sure documentation is up-to-date Dec 4, 2018
@dhmlau dhmlau added 2019Q2 and removed TOB labels Mar 21, 2019
@bajtos bajtos changed the title [Epic] Make sure documentation is up-to-date [Epic] Make sure documentation is up-to-date (2019Q2 May 14, 2019
@bajtos bajtos changed the title [Epic] Make sure documentation is up-to-date (2019Q2 [Epic] Make sure documentation is up-to-date (2019Q2 Edition) May 14, 2019
@dhmlau dhmlau added the p1 label May 16, 2019
@dhmlau
Copy link
Member Author

dhmlau commented Jul 8, 2019

Closing as done.

@dhmlau dhmlau closed this as completed Jul 8, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

3 participants