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

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

Closed
Gankro opened this Issue Oct 19, 2014 · 5 comments

Comments

Projects
None yet
5 participants
@Gankro
Copy link
Contributor

Gankro commented Oct 19, 2014

Would use localStorage to maintain state between pages.

Ideas:

  • Collapse permanency settings from #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
@azerupi

This comment has been minimized.

Copy link
Contributor

azerupi commented Aug 8, 2015

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

@Gankro

This comment has been minimized.

Copy link
Contributor Author

Gankro commented Aug 9, 2015

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...

@azerupi

This comment has been minimized.

Copy link
Contributor

azerupi commented Aug 9, 2015

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

@ghost

This comment has been minimized.

Copy link

ghost commented Oct 24, 2016

Yes please. Collapsing all of the methods alone would be a huge improvement.

@the8472

This comment has been minimized.

Copy link

the8472 commented Nov 25, 2016

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.