Skip to content

Add settings page to Rustdoc for long-term configuration #18167

Closed

Description

@Gankra

Would use localStorage to maintain state between pages.

Ideas:

  • Collapse permanency settings from rustdoc: make collapsing permanent #17126. Two independent check-boxes:
    • Always collapse function-level docs
    • Always collapse top-level docs
  • Hide deprecated functions
  • Hide unsafe functions
  • Only show stable functions

Activity

  1. added
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Jan 27, 2015
  2. azerupi commented on Aug 8, 2015

    @azerupi
    Contributor

    I have used localStorage extensively for the same kind of thing in a project of mine. It's a little bit messy, but maybe it can help :)

    https://github.com/azerupi/SOTAwatch-filter/blob/master/development/js/spots/settings.js#L41-L181

  3. Gankra commented on Aug 9, 2015

    @Gankra
    ContributorAuthor

    I've also used localStorage a fair amount (granted, 3 years ago): https://github.com/WhatPumpkin/Sburb/blob/master/src/serialization.js#L69-L158

    Honestly the main thing that prevented me from ever going at this was building the menus and stuff. UI designers wanted :)

    I suppose I could make stuff persist without giving any way to configure...

  4. azerupi commented on Aug 9, 2015

    @azerupi
    Contributor

    Honestly the main thing that prevented me from ever going at this was building the menus and stuff. UI designers wanted :)

    I have a couple of ideas:

    1. Add one more keyboard shortcut. Like the current ? another keyboard shortcut could open an options panel with some check-boxes.
    2. Reduce the width of the search bar a little bit and place an cog icon on the right of it, that opens a panel when clicked.

    Another thing I would add to that settings panel is the a toggle for serif / sans-serif font


    Like a mentioned in a post on Rust internals, I think it's worth having a centralized place for all the design decisions where designers would be invited to post ideas and mock-ups

  5. the8472 commented on Nov 25, 2016

    @the8472
    Member

    Javadoc has a separate method summary table + detailed documentation further down. Since rustdoc does not have that it's necessary to collapse the details every time to get an overview.

    I usually have a rough idea what I want and just need to find that one method out of a myriad, so I would prefer the methods to be collapsed by default.

  6. added
    T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.
    and removed on May 18, 2017
  7. added a commit that references this issue on Apr 22, 2018
    28193e8
  8. added a commit that references this issue on Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-feature-requestCategory: A feature request, i.e: not implemented / a PR.T-dev-toolsRelevant to the dev-tools subteam, which will review and decide on the PR/issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions