Skip to content

DOC Introduce dropdowns in the User Guide #26617

@ArturoAmorQ

Description

@ArturoAmorQ

Describe the issue linked to the documentation

Dropdowns are implemented in #26625. They can help users avoid scrolling trough large pages and can quickly get them access to the content they are interested in.

Suggest a potential alternative/fix

Use dropdowns to hide:

  • low hierarchy sections such as References, Properties, etc. See for instance the subsections in 3.3.2.16 Detection error tradeoff (DET);
  • in-depth mathematical details;
  • narrative that is too use-case specific;
  • narrative that may only interest users that want to go beyond the pragmatics of a given tool.

Additionally:

  • Do not use dropdowns for the low level section Examples, as it should stay visible to all users. Make sure that the Examples section comes right after the main discussion with the least possible folded section in-between.
  • Be aware that dropdowns break cross-references. If that makes sense, hide the reference along with the text mentioning it. Else, do not use dropdown.

For more information see Contributing to documentation, notably the "Guidelines for writing the User Guide and other reStructuredText documents" dropdown.

This is the list of sub-modules to be addressed:

Contributors willing to address this issue, please offer one of the above sub-modules per pull request. Remember also to mention on which module you are working on.

Thanks for your help!

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationMeta-issueGeneral issue associated to an identified list of tasksgood first issueEasy with clear instructions to resolve

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions