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: modify sidebar #3333

Merged
merged 2 commits into from
Jul 12, 2019
Merged

docs: modify sidebar #3333

merged 2 commits into from
Jul 12, 2019

Conversation

dhmlau
Copy link
Member

@dhmlau dhmlau commented Jul 11, 2019

Modify sidebar as proposed in PR #3164.

Current side:

current-sidebar

New sidebar:
new-sidebar

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

@raymondfeng
Copy link
Contributor

Is it the only difference to add a new Overview?

@dhmlau
Copy link
Member Author

dhmlau commented Jul 11, 2019

Is it the only difference to add a new Overview?

much more. :)

  • Overview is the only item I added.
  • I've removed: FAQ and Glossary. @bschrammIBM mentioned a while ago and I tend to agree with her that those two pages aren't very useful. We have key concepts that are duplicate of glossary.
  • For others, I've rearranged per the proposal.

@dhmlau
Copy link
Member Author

dhmlau commented Jul 11, 2019

@raymondfeng , I'd like to get the simpler/less controversial changes in this PR first, and then make a bigger refactoring for the key concepts and other section.

@hacksparrow
Copy link
Contributor

hacksparrow commented Jul 11, 2019

API Docs should stand out as a separate link at the top or bottom of the list shown. The most crucial link can't be "lost" somewhere down the list.

@dhmlau
Copy link
Member Author

dhmlau commented Jul 11, 2019

There's a API Docs at the top of the page, as part of the template.
However, it is pointing to apidocs.loopback.io. If someone is using LB4 and click that link, he/she will be asked to click another link for the LB4 API docs. I guess the best way is to move the API docs completely (with LB3) to our docs.

@raymondfeng
Copy link
Contributor

Should we move Tutorials down?

@dhmlau
Copy link
Member Author

dhmlau commented Jul 11, 2019

sure. where to?

@dhmlau
Copy link
Member Author

dhmlau commented Jul 12, 2019

@raymondfeng, I've moved down the Tutorial section. PTAL. Thanks.
Screen Shot 2019-07-12 at 2 24 13 PM

@dhmlau dhmlau merged commit b1c1ea2 into master Jul 12, 2019
@delete-merged-branch delete-merged-branch bot deleted the sidebar branch July 12, 2019 20:43
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

Successfully merging this pull request may close these issues.

4 participants