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

improve documentation layout #199

Open
dlqqq opened this issue May 30, 2023 · 0 comments
Open

improve documentation layout #199

dlqqq opened this issue May 30, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@dlqqq
Copy link
Member

dlqqq commented May 30, 2023

Problem

We are approaching the point at which there is too much text in the user documentation to fit in a single page. Without a high-level index of a page, e.g. in a left sidebar, users will have a hard time discovering the documentation relevant to whatever use-case they're looking for. However, with the Sphinx theme we are using (pydata-sphinx-theme), it is definitely possible to have subpages within the user documentation, indexed by a left sidebar. Take a look here:

Screen Shot 2023-05-30 at 2 06 37 PM

Proposed Solution

Figure out what configuration is necessary to achieve this, and split the chat and magics documentation into separate pages.

@dlqqq dlqqq added documentation Improvements or additions to documentation enhancement New feature or request labels May 30, 2023
@JasonWeill JasonWeill added this to the 3.0.0 Release milestone Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants