doc: make stability labels more consistent #57516
Conversation
|
Review requested:
|
|
So the rule of thumb is, if there is a parent it inherits the parent stability index, otherwise it needs to be declared |
Yeah I think that's how we've treated it. I'll try to see if I can update the tooling to:
|
|
The CSS part would need a bit more work, help would be welcome /cc @nodejs/nodejs-website |
Your CSS looks good to me, assuming I’ve understood it correctly. It ensures the stability header stays just below the navbar. However, if that’s not the intended behavior, I’m happy to take another look. |
|
You can see the unintended behavior e.g. in http://127.0.0.1:8000/url.html#class-urlsearchparams, where |
|
Well, the tooling for generating the documentation is about to change, (see #57343), and this CSS issue does not occur in that tooling (in fact, a different CSS issue occurs with the stability node not sticking for children elements) (see nodejs/api-docs-tooling#215). Honestly, I'd personally advice against changing the CSS at all, as in the coming months, the entire docs page is (as i'm sure you are aware), being redesigned. That being said, if you would still like to see this CSS change, I'd be happy to look into a solution for the issue you are facing in both this PR, and in the new tooling. (By the way, I'm sure the website team can definitely look into ways of indicating inherited stability for the redesign) |
+1, @aduh95 I appreciate your commit and the time invested here, but the whole tooling is about to change. Could you defer any update till then? Changes are really really imminent 🙏 |
|
I've added the wrappers, fixing #57516 (comment)
This PR is ready to land, I don't think it'd wise to wait for it to gather conflicts |
lpinca
added
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 524c078 |
PR-URL: #57516 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
PR-URL: nodejs#57516 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
PR-URL: #57516 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
PR-URL: #57516 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
Our docs are not very consistent when it comes to
Stability 1: Stablelabels, for most occurrences each section inherits from its parent section, but in some cases there's a redundant label, and e.g. inglobals.mdorcli.md, many sections do not have any label at all, despite being de facto stable. This PR tries to fix all those inconsistencies.