search

tc39 / proposals

Tracking ECMAScript Proposals
https://tc39.github.io/process-document/
18.02k stars 712 forks source link

Add heading to ToC #518

Closed tabatkins closed 2 months ago

tabatkins commented 2 months ago

The "Onboarding Existing Proposals" heading is hidden down at the very bottom, and not present in the ToC at the top, so it's not clear that it exists unless you scroll down multiple screenfuls, past a bunch of proposal listings that does not suggest anything significant follows them.

ctcpip commented 2 months ago

Screenshot 2024-04-23 at 12 41 51 PM

this is a good change, but can we make a structural change too? the onboarding topic should come after (and perhaps nested within) the contributing topic (and not be nested within the active proposals heading).

also I suggest renaming to just 'onboarding proposals'. the term 'existing' is slightly confusing

ljharb commented 2 months ago

the thing at the top isn't a TOC - every markdown file on github has a TOC built in, which already contains this item.

ctcpip commented 2 months ago

the thing at the top isn't a TOC - every markdown file on github has a TOC built in, which already contains this item.

not sure which of us you are responding to, but if it's to me: the built-in ToC displays the markdown hierarchy, so I was using the screenshot to display the issue I'd like to address, which is two-fold: the ordering and the nesting

ljharb commented 2 months ago

that was to the OP. The list of 4 items at the top isn't a TOC, because it links to different files.

I'm neutral on the ordering and nesting.

ctcpip commented 2 months ago

realizing I am sort of hijacking this PR. I will follow up on my issues in another PR

ctcpip commented 2 months ago

@tabatkins I think #519 perhaps resolved this? the net change is that content is still at the bottom of the page, and includes the reference to how-we-work. but there is a link at the top of the page to take you to this information

tabatkins commented 2 months ago

the thing at the top isn't a TOC - every markdown file on github has a TOC built in, which already contains this item.

I have never noticed that button before. That's useful! The point still stands, tho - we have what appears to be a ToC inlined to the top of the document, and it doesn't suggest there's another section way down at the bottom.

tabatkins commented 2 months ago

(But I think rearranging things as @ctcpip suggests will negate the need for adding anything to the "ToC".)

tabatkins commented 2 months ago

Ah, @ctcpip did the changes themself. That satisfies my concern, I'll close this.