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.

Sign up for GitHub

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

Jump to bottom

doc: make header smaller and dropdown click-driven when JS is on #42165

Merged
merged 7 commits into from
Mar 22, 2022
Merged

doc: make header smaller and dropdown click-driven when JS is on #42165

merged 7 commits into from
Mar 22, 2022

Conversation

ShogunPanda
Copy link
Contributor

@ShogunPanda ShogunPanda commented Mar 1, 2022 •
edited by aduh95
Loading

This PR finishes the work started on #41404 by making the header small and the menu click-driver when JS is available on the browser.

Fixes: #42286

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 1, 2022
@Trott
Copy link
Member

Trott commented Mar 1, 2022

@nodejs/website

VoltrexKeyva
VoltrexKeyva reviewed Mar 1, 2022
View reviewed changes
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
@ShogunPanda
Copy link
Contributor Author

@Trott Actually I was able to enable linting for that file just by removing it from the ignore list. No issues encountered so far.

@VoltrexMaster Thanks for all your suggestions. It was the same list I got when I eslint-ed the file locally so I did it directly on my working tree.

@ShogunPanda ShogunPanda force-pushed the improve-api-docs-layout-js branch from d1a018c to 4aa204e Compare March 2, 2022 13:18
@ShogunPanda
Copy link
Contributor Author

Any update on this? Is this ready to go?

@Trott
Copy link
Member

Trott commented Mar 4, 2022

@nodejs/website @nodejs/documentation

aduh95
aduh95 reviewed Mar 11, 2022
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sticky header never shows up on screen smaller than 1000px height, I don't think it's expected, is it?

doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
@ShogunPanda
Copy link
Contributor Author

The sticky header never shows up on screen smaller than 1000px height, I don't think it's expected, is it?

It was when there was no JS. I've fixed it now. Thanks for noticing.

@ShogunPanda ShogunPanda force-pushed the improve-api-docs-layout-js branch from 4aa204e to e23f274 Compare March 18, 2022 11:39
aduh95
aduh95 reviewed Mar 18, 2022
View reviewed changes
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
@ShogunPanda ShogunPanda force-pushed the improve-api-docs-layout-js branch from 87ee85f to cd6e683 Compare March 18, 2022 16:59
aduh95
aduh95 reviewed Mar 18, 2022
View reviewed changes
doc/template.html Outdated Show resolved Hide resolved
@ShogunPanda
Copy link
Contributor Author

@aduh95 Are we good to go on this? Can I land it?

aduh95
aduh95 reviewed Mar 21, 2022
View reviewed changes
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I didn't had the occasion to pull up your branch to test the latest changes. I still have a few suggestions, but this is very close to be ready.

doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Outdated Show resolved Hide resolved
doc/api_assets/api.js Show resolved Hide resolved
@ShogunPanda ShogunPanda force-pushed the improve-api-docs-layout-js branch from 60f14ba to 5e2d376 Compare March 22, 2022 06:58
@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Mar 22, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 22, 2022
@nodejs-github-bot nodejs-github-bot merged commit 0f79a27 into nodejs:master Mar 22, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 0f79a27

@ShogunPanda ShogunPanda deleted the improve-api-docs-layout-js branch March 23, 2022 06:48
juanarbol pushed a commit that referenced this pull request Apr 4, 2022
@ShogunPanda @juanarbol
doc: make header smaller and dropdown click-driven when JS is on
c89ed0c 
PR-URL: #42165
Fixes: #42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
juanarbol pushed a commit to juanarbol/node that referenced this pull request Apr 5, 2022
@ShogunPanda @juanarbol
doc: make header smaller and dropdown click-driven when JS is on
89da27c 
PR-URL: nodejs#42165
Fixes: nodejs#42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
This was referenced Apr 5, 2022
Closed
Merged
juanarbol pushed a commit that referenced this pull request Apr 6, 2022
@ShogunPanda @juanarbol
doc: make header smaller and dropdown click-driven when JS is on
00f693b 
PR-URL: #42165
Fixes: #42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
xtx1130 pushed a commit to xtx1130/node that referenced this pull request Apr 25, 2022
@ShogunPanda @xtx1130
doc: make header smaller and dropdown click-driven when JS is on
a7b9085 
PR-URL: nodejs#42165
Fixes: nodejs#42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
juanarbol pushed a commit that referenced this pull request May 31, 2022
@ShogunPanda @juanarbol
doc: make header smaller and dropdown click-driven when JS is on
54720f5 
PR-URL: #42165
Fixes: #42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@juanarbol juanarbol mentioned this pull request May 31, 2022
Closed
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
@ShogunPanda @danielleadams
doc: make header smaller and dropdown click-driven when JS is on
2048082 
PR-URL: #42165
Fixes: #42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos pushed a commit that referenced this pull request Jul 11, 2022
@ShogunPanda @targos
doc: make header smaller and dropdown click-driven when JS is on
5b5295f 
PR-URL: #42165
Fixes: #42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
targos pushed a commit that referenced this pull request Jul 31, 2022
@ShogunPanda @targos
doc: make header smaller and dropdown click-driven when JS is on
d9ae6c7 
PR-URL: #42165
Fixes: #42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
@targos targos mentioned this pull request Aug 3, 2022
Merged
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@ShogunPanda @guangwong
doc: make header smaller and dropdown click-driven when JS is on
e820a08 
PR-URL: nodejs/node#42165
Fixes: nodejs/node#42286
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@VoltrexKeyva VoltrexKeyva VoltrexKeyva left review comments

@Trott Trott Trott left review comments

@aduh95 aduh95 aduh95 approved these changes

@aymen94 aymen94 aymen94 approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

doc: HTML API docs' fixed header obscures anchored content
6 participants
@ShogunPanda @Trott @nodejs-github-bot @aymen94 @aduh95 @VoltrexKeyva