Skip to content

docs(book): fix missing H1 and misleading page titles - #659

Open
salch-cred wants to merge 1 commit into
PsycheFoundation:mainfrom
salch-cred:docs/fix-page-titles
Open

docs(book): fix missing H1 and misleading page titles#659
salch-cred wants to merge 1 commit into
PsycheFoundation:mainfrom
salch-cred:docs/fix-page-titles

Conversation

@salch-cred

Copy link
Copy Markdown

Summary

Three page-title defects found by cross-checking every \SUMMARY.md\ entry against each page's first heading:

  • \development/contributing.md\ had no H1 at all — the page title existed only as an H2, so the rendered page had no top-level heading and mdbook's chapter title came solely from the sidebar. Promoted to H1 and demoted the sections one level to keep the hierarchy consistent.
  • *\enduser/index.md* — H1 said \End-user configuration\ but the chapter is \End-user usage\ (and the page is an index, not a config reference).
  • *\enduser/quickstart-compute-provider.md* — H1 said \Providing Compute to NousNet, a brand name the rest of the book doesn't use (everything else says Psyche).

Left untouched: the many sidebar-label-vs-H1 differences that are intentional short labels (\Rewards\ vs \Training Rewards, etc.).

No links, no prose changes beyond the three titles.

- contributing.md had no H1 (page title only as H2), leaving the
  rendered page without a title; promote it and demote its sections to
  keep the hierarchy consistent
- enduser/index.md H1 said 'End-user configuration' while the section
  is 'End-user usage'
- quickstart H1 said 'Providing Compute to NousNet' while the project
  is consistently branded Psyche elsewhere in the book
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant