Switch settings menu to full js by GuillaumeGomez · Pull Request #93097 · rust-lang/rust

GuillaumeGomez · 2022-01-19T22:11:22Z

Since the settings can only be set when the JS is enabled, it's not really a problem. It also fixes a debate we had around the themes not being accessible easily before.

You can test it here.

r? @jsha

rust-highfive · 2022-01-19T22:11:24Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez,@Folyd

jsha · 2022-01-19T22:22:11Z

Some early feedback from testing: This should generate a page navigation event, like searching does, so that when you hit the "back" button in your browser you go back to the page you were on.

The page navigation event should make the URL /settings.html, and we could keep an actual settings.html that just calls the JS to generate the page contents.

GuillaumeGomez · 2022-01-19T22:24:47Z

The page navigation event should make the URL /settings.html, and we could keep an actual settings.html that just calls the JS to generate the page contents.

That'd mean that we'd need to have a settings.html file in every folder, no? Maybe simpler to keep it like search with a query parameter, don't you think?

jsha · 2022-01-19T22:30:56Z

That'd mean that we'd need to have a settings.html file in every folder, no? Maybe simpler to keep it like search with a query parameter, don't you think?

No, I'm proposing to have one settings.html per documentation instance, just like we have today - and in exactly the same place.

GuillaumeGomez · 2022-01-19T22:38:23Z

No, I'm proposing to have one settings.html per documentation instance, just like we have today - and in exactly the same place.

I'm not a big fan of the idea: it means duplicating where the settings are set and generated... I think it's extra work for not much gain.

jsha · 2022-01-19T22:41:54Z

it means duplicating where the settings are set and generated... I think it's extra work for not much gain.

I think you misunderstand me. I'm not proposing that we should generate the settings into HTML. I'm proposing that we have HTML that is an empty shell, and just calls loadScript(window.settingsJS);. The settingsJS is still responsible for rendering the settings via JS.

GuillaumeGomez · 2022-01-19T22:45:30Z

it means duplicating where the settings are set and generated... I think it's extra work for not much gain.
I think you misunderstand me. I'm not proposing that we should generate the settings into HTML. I'm proposing that we have HTML that is an empty shell, and just calls loadScript(window.settingsJS);. The settingsJS is still responsible for rendering the settings via JS.

Oh indeed. Great idea!

bors · 2022-01-20T02:59:08Z

☔ The latest upstream changes (presumably #93085) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2022-01-23T13:14:03Z

☔ The latest upstream changes (presumably #93220) made this pull request unmergeable. Please resolve the merge conflicts.

jsha · 2022-04-28T17:28:06Z

This needs another merge deconflict.

jsha · 2022-04-28T17:43:27Z

From the demo:

Two problems:

This says "preferred-dark-theme" etc, but should say "Preferred dark theme"
The "Preferred light theme" setting should come ahead of the "Preferred dark theme" as it currently does.

GuillaumeGomez · 2022-04-28T20:39:02Z

Thanks for the review! I'll update it tomorrow.

GuillaumeGomez · 2022-04-29T10:39:14Z

Updated!

bors · 2022-04-30T01:00:12Z

☔ The latest upstream changes (presumably #96566) made this pull request unmergeable. Please resolve the merge conflicts.

GuillaumeGomez · 2022-04-30T11:20:34Z

Fixed merge conflicts. :)

jsha · 2022-05-01T16:17:40Z

This still has "Preferred dark theme" above "Preferred light theme." It should be the other way around, to match the current UI.

* Improve code. * Fix some documentation argument types. * Make settings order the same as before this PR. * Change timeout to 0 so that browser will render it as fast as possible.

GuillaumeGomez · 2022-05-01T19:24:57Z

Updated and uploaded updated version. :)

jsha · 2022-05-02T19:42:03Z

@bors r+ rollup

bors · 2022-05-02T19:42:04Z

📌 Commit 73688e4 has been approved by jsha

GuillaumeGomez · 2022-05-02T19:44:22Z

🎉

Switch settings menu to full js Since the settings can only be set when the JS is enabled, it's not really a problem. It also fixes a debate we had around the themes not being accessible easily before. ![Screenshot from 2022-01-19 23-06-59](https://user-images.githubusercontent.com/3050060/150221936-fd1a1e76-06b6-4416-a653-dbae111979ed.png) You can test it [here](https://rustdoc.crud.net/imperio/settings-js/doc/foo/index.html). r? `@jsha`

Rollup of 8 pull requests Successful merges: - rust-lang#93097 (Switch settings menu to full js) - rust-lang#96587 (Refactor the WriteBackendMethods and ExtraBackendMethods traits) - rust-lang#96589 (Use source callsite in check_argument_types suggestion) - rust-lang#96599 (Update `RValue::Discriminant` documentation) - rust-lang#96614 (Add a regression test for rust-lang#92305) - rust-lang#96629 (Fix invalid keyword order for function declarations) - rust-lang#96641 (Use a yes/no enum instead of a bool.) - rust-lang#96646 (Mitigate impact of subtle invalid call suggestion logic) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) A-rustdoc-js Area: Rustdoc's JS front-end labels Jan 19, 2022

rust-highfive assigned jsha Jan 19, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 19, 2022

This comment has been minimized.
Sign in to view

GuillaumeGomez force-pushed the settings-js branch from 47262e1 to 38cca7eCompare January 19, 2022 22:28

jsha suggested changes Jan 19, 2022
View reviewed changes

Comment threadsrc/librustdoc/templates/page.html Outdated

jsha suggested changes Jan 19, 2022
View reviewed changes

Comment threadsrc/librustdoc/html/static/js/main.js Outdated

This comment has been minimized.
Sign in to view

GuillaumeGomez force-pushed the settings-js branch from 38cca7e to 6f6e078Compare January 20, 2022 12:09

This comment has been minimized.
Sign in to view

jsha mentioned this pull request Jan 23, 2022
Please bring back the paintbrush icon, or an equivalent! #93216
Closed

GuillaumeGomez mentioned this pull request Feb 18, 2022
T keyboard shortcut no longer functions on new docs layout #94048
Closed

JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 27, 2022

GuillaumeGomez mentioned this pull request Mar 4, 2022
Move theme picker button to the right and display it on all pages #94607
Closed

GuillaumeGomez force-pushed the settings-js branch from 6f6e078 to 9630fe7Compare March 14, 2022 22:33

This comment has been minimized.
Sign in to view

GuillaumeGomez force-pushed the settings-js branch from 780d3e8 to cb02defCompare March 15, 2022 16:50

jsha suggested changes Apr 28, 2022
View reviewed changes

Comment threadsrc/librustdoc/html/static/js/settings.js Outdated
Comment threadsrc/librustdoc/html/static/js/settings.js Outdated

GuillaumeGomez force-pushed the settings-js branch from fe99791 to 2ac2fbbCompare April 29, 2022 10:37

GuillaumeGomez added 3 commits April 30, 2022 13:12

Move settings into full JS
9625ed8

Add GUI test for settings menu
e7d7d75

Extend settings test to ensure settings text is as expected
2f074de

GuillaumeGomez force-pushed the settings-js branch from 0d2c340 to 2f074deCompare April 30, 2022 11:20

jsha suggested changes May 1, 2022
View reviewed changes

Comment threadsrc/librustdoc/html/static/js/main.js Outdated
Comment threadsrc/librustdoc/html/static/js/main.js Outdated
Comment threadsrc/librustdoc/html/static/js/settings.js Outdated
Comment threadsrc/librustdoc/html/static/js/settings.js Outdated

* Add documentation for settings page rendering functions.
73688e4
* Improve code. * Fix some documentation argument types. * Make settings order the same as before this PR. * Change timeout to 0 so that browser will render it as fast as possible.

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 2, 2022

GuillaumeGomez mentioned this pull request May 2, 2022
Rollup of 8 pull requests #96653
Closed

JohnTitor mentioned this pull request May 3, 2022
Rollup of 8 pull requests #96663
Merged

bors merged commit 27d7615 into rust-lang:masterMay 3, 2022

rustbot added this to the 1.62.0 milestone May 3, 2022

GuillaumeGomez deleted the settings-js branch May 3, 2022 09:22

notriddle mentioned this pull request Oct 14, 2022
rustdoc: make the help button a link to a page #103060
Merged

Uh oh!

Uh oh!

Conversation

GuillaumeGomez commented Jan 19, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Jan 19, 2022

Uh oh!

jsha commented Jan 19, 2022

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Jan 19, 2022

Uh oh!

Uh oh!

jsha commented Jan 19, 2022

Uh oh!

Uh oh!

GuillaumeGomez commented Jan 19, 2022

Uh oh!

jsha commented Jan 19, 2022

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Jan 19, 2022

Uh oh!

bors commented Jan 20, 2022

Uh oh!

This comment has been minimized.

bors commented Jan 23, 2022

Uh oh!

This comment has been minimized.

This comment has been minimized.

jsha commented Apr 28, 2022

Uh oh!

jsha commented Apr 28, 2022

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez commented Apr 28, 2022

Uh oh!

GuillaumeGomez commented Apr 29, 2022

Uh oh!

bors commented Apr 30, 2022

Uh oh!

GuillaumeGomez commented Apr 30, 2022

Uh oh!

jsha commented May 1, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GuillaumeGomez commented May 1, 2022

Uh oh!

jsha commented May 2, 2022

Uh oh!

bors commented May 2, 2022

Uh oh!

GuillaumeGomez commented May 2, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

GuillaumeGomez commented Jan 19, 2022•
edited
Loading