o1-labs / rfcs

RFCs for everything O(1) Labs
4 stars 4 forks source link

remove extraneous markdown heading since TOC is auto in GitHub #10

Closed barriebyron closed 1 year ago

barriebyron commented 1 year ago

The template was created with legacy Markdown syntax that is no longer necessary and breaks the CI.

We no longer need the old-style Markdown syntax to create heading anchors in GitHub Markdown because of the automatic in-file navigation: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax (different UX now, the hamburger menu is now top right) gist: When you use two or more headings, GitHub automatically generates a table of contents that you can access by clicking (hamburger menu) within the file header. Each heading title is listed in the table of contents, and you can click a title to navigate to the selected section.

Poof! gone