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

Please update the documentation on how the sidebar / pagination work. #1083

Open
joetidee opened this issue Mar 18, 2020 · 1 comment
Open

Please update the documentation on how the sidebar / pagination work. #1083

joetidee opened this issue Mar 18, 2020 · 1 comment
Labels

Comments

@joetidee
Copy link

@joetidee joetidee commented Mar 18, 2020

Currently, there seems to to be very little instruction on how/why certain combinations of _sidebar.md files and folder structures make the sidebar navigation and pagination work.

For example, if my _sidebar.md file contains this:

- **Services**
    - [Getting Started](services/getting-started.md)
    - [Running Service Locally](services/running-services.md)

and my folder structure is this:

/services
  _sidebar.md
  index.md
  getting-started.md
  running-services.md

the pagination and menu structure works fine. But there is no explanation to why this works. If I move .md files into sub-folders, pagination doesn't work. If I simply have...

- [**Services**](services/index.md)

then pagination does not appear and the sidebar no longer shows the sub-pages. It is quite difficult to know where to place files and what to put into the sidebar to try and get a solution whereby the sidebar can auto-generate itself correctly and the pagination work as expected.

@stale
Copy link

@stale stale bot commented May 18, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label May 18, 2020
@anikethsaha anikethsaha removed the wontfix label May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.