GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | |||||||||||||||||||||||||||||||||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | |||||||||||||||||||||||||||||||||||||||||||||||||
GeezerVison is showing github.com — TOC in details · Pull Request #36896 · nodejs/node Conversation
|
|
Also, we need to adjust the stylesheet to the new DOM structure. You should replace Lines 475 to 477 in 1a0c5d5
with #toc > ul { margin-top: 1.5rem; } |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
This PR breaks the script that generates the Lines 34 to 37 in 1a0c5d5
to const match = /(<\/ul>\s*)?<\/\w+>\s*<\w+ id="apicontent">/.exec(data); contents += data.slice(0, match.index) .replace(/[\s\S]*?id="toc"[^>]*>\s*<\w+>.*?<\/\w+>\s*(<ul>\s*)?/, '') and Line 62 in 1a0c5d5
to const tocStart = /<\w+ id="toc"[^>]*>\s*<\w+>.*?<\/\w+>\s*/.exec(all); |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
I'm confused, why do you want to revert? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Would it help if I push myself the changes I'm suggesting to your branch to make the CI content? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
@mattiapontonio you actually can add several files in one PR; if you want to do so from GitHub web UI, you need to visit the file on your branch (https://github.com/mattiapontonio/node/blob/patch-1/tools/doc/allhtml.js), click edit, and commit on the same |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I stand by my original comment – repeating "Table of content" is not great, and we should have the open attribute so the TOC is not hidden by default.
You are going to need to update the allhtml.js file as described in my above comment, and also update the style.css before this can land.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
@mattiapontonio are you closing this because you don't want to work on it anymore or did you get block in the process? I hope my comments didn't discourage you, I'm convinced this PR could greatly improve our docs, especially for people browsing them on mobile, and I'm eager to help you land it – if you need or want any help. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
@aduh95 |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
No, you need to change at least three files. But why is that stopping you? You can modify as many files as you want in one PR by adding more commits to the branch. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
I'm from a smartphone... |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
You can do that from the GitHub web CI. I just added a commit to your branch using my smartphone. Try to follow this link and click the edit button: https://github.com/mattiapontonio/node/blob/patch-1/tools/doc/allhtml.js |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
Yes but i don't want to do that, i want to wrap the TOC in a Lets wait CI for this commit. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
What's the reason you don't want that? Do you think it would look worse or you just don't want to touch the other files because it's not easy to do from a smartphone? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
The second one. Side issue |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
OK, so are you OK if I push those changes to your branch myself? I'm afraid that's the only way to get a green CI if you change this part of the HTML. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
Yes but please let me see the change (for learning). |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
You mean you'd prefer without the /cc @nodejs/documentation what are your thoughts on this? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
See MDN for a preview (Jump to section). |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Yes |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
It's ok for me to leave this |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
I'd be fine with that too. I was thinking maybe we could add a tiny JS script that automatically removes the |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/4215/ |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
PR-URL: #36896 Fixes: #36885 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
|
Landed in 2ba8728 |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
What landed means? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
I think is better to be consistent between HTMLs |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
@mattiapontonio your patch has been applied on the HEAD of the master branch instead of performing a merge commit because merges break our tooling. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
Weird. So it's not deployed. And It Will not be? I'm from a smartphone, i can only screeshot what I see here. I'm expecting something like this |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
It will be part of the next release (well not the next one, because v15.6.0 cut off date has already passed, so the one after that), and then the docs on nodejs.org will be updated with your change. You may use the build artefact from GitHub CI to see the result already: https://github.com/nodejs/node/suites/1829898807/artifacts/35314688 |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Ok 👍 |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
|
One small issue this creates is that the triangle symbol now means different things (or at least behaves differently) in nearby places in the page. It's different in the version picker drop-down than it is for the table of contents. We might want to think about modifying the version picker slightly. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Should be intresting to see this deployed not in nodejs.org |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
Where is the HTML of that? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
PR-URL: #36896 Fixes: #36885 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
No, it's not a details tag. <a href="#">View another version <span>▼</span></a> |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Apparently not even ToC. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
PR-URL: #36896 Fixes: #36885 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
Table of contents in a <details>
There was an error while loading. Please reload this page.