Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: Update all documentation for @loopback/rest refactor #613

Closed
11 tasks done
kjdelisle opened this issue Oct 3, 2017 · 4 comments
Closed
11 tasks done

docs: Update all documentation for @loopback/rest refactor #613

kjdelisle opened this issue Oct 3, 2017 · 4 comments
Assignees

Comments

@kjdelisle
Copy link
Contributor

kjdelisle commented Oct 3, 2017

Summary

After the refactor to move all of the HTTP/REST items into their own package, we need to update all of the documentation that involves use of those modules and functions.

Acceptance Criteria

Review and update the documentation. Make sure the updated code snippets work! (You can use acceptance tests or example apps to help you with verification.)

loopback.io pages:

  • Thinking in LoopBack
  • Key concepts
  • Getting started
  • Using Components
  • Creating Components
  • Calling other APIs
  • Testing Your Application
  • Migration guide
  • Crafting LoopBack 4 - No code snippet in this page
  • Reference

loopback-next:

  • review and fix per-package READMEs (authentication, etc.) (Diana)
@dhmlau
Copy link
Member

dhmlau commented Oct 3, 2017

@kjdelisle , I can work on reviewing the READMEs since I've started on one already.

@crandmck
Copy link
Contributor

crandmck commented Oct 5, 2017

We also need to update the API docs, specifically we need to add the new package to https://github.com/strongloop-internal/apidocs.strongloop.com/blob/master/ts-repos.json

@dhmlau
Copy link
Member

dhmlau commented Oct 6, 2017

@crandmck , I could submit a PR for the change in ts-repos.json if you want. But I'm not sure how to verify it.

#622 is created

@kjdelisle
Copy link
Contributor Author

Closing as complete!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants