Skip to content

[v3-future] Show navigation sidebar in documentation #199

Open
@dlqqq

Description

@dlqqq

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    Status

    3.x backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions