Skip to content

Commit 7252fae

Browse files
committed
docs: point the readme-as-doc-site how-to at the live Reference as a living example
1 parent 030062c commit 7252fae

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

www-next-gen/how-tos/render-readme-as-doc-site.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,14 @@ let pages = ($readme | split row "\n## " | skip 1 | each {|s|
5151
Add a sidebar that lists the sections and you have navigation. The README stays
5252
the single source of truth; you just slice it.
5353

54+
> **A living example.** You do not have to imagine the result, you are reading
55+
> inside it. The [Reference](/reference) section of this site is the http-nu
56+
> README run through exactly the code above: one page per `## ` heading, a
57+
> sidebar built from the slugs, a prev/next pager. Go open it and click between
58+
> sections, watch the URL become each slug, then come back here, the code will
59+
> read like a description of what you just used. That is the whole lesson: the
60+
> doc site and the README are the same thing.
61+
5462
## Typography
5563

5664
`.md` gives you semantic HTML, so style raw tags once and every page looks good

0 commit comments

Comments
 (0)