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

Information architecture: collapse table of contents? #2477

Closed
stichbury opened this issue Mar 29, 2023 · 1 comment
Closed

Information architecture: collapse table of contents? #2477

stichbury opened this issue Mar 29, 2023 · 1 comment
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

This is a child of #1866

We know the table of contents is too long in the documentation, and there will be various activities to reorganise the structure and slim down the sections/pages.

An additional suggestion from @amandakys was to attempt to contract it to sections that can be expanded as needed, rather than show section + child pages.

I know we can do some of this by increasing the complexity of the docs through hierarchy (using embedded .rst files within the main .rst or the MyST equivalent). I'd like to give this a try for a release to see what feedback we get (if any).

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Mar 29, 2023
@yetudada yetudada changed the title Information architecture: collapse table of contents ? Information architecture: collapse table of contents? Apr 5, 2023
@stichbury
Copy link
Contributor Author

Now merged for us to release and use as a baseline for user research. See #2480 for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

No branches or pull requests

1 participant