Expand description
nova doc: the documentation site (spec
docs/superpowers/specs/2026-10-11-phase-3-5a-the-documentation-site-design.md;
ADR 0034).
Structs§
- Broken
Link - A link that leads nowhere: the page it is on, from the site’s root, and the link as written.
- Code
Block - A code block, and where its lines are in the Markdown.
- Code
Line - A line of a code block.
- DocTest
- A doc test: one Nova code block of the docs a library’s site shows, as a test module (spec §5).
- Documented
- A program documented: its site, and the warnings its analysis found, with the files they point into.
- Site
- A site: its packages, std last (spec §6.1).
Enums§
- Block
- What a code block is (3.5b spec §4.2).
- Failure
- Why a program was not documented.
- Origin
- Where a line of a doc test’s text comes from (spec §7).
- Write
Error - Why a site was not written.
Constants§
- MARKER
- The file every site holds, so that
nova docreplaces only a directory it wrote (spec §4.3).
Functions§
- check_
links - Every link in the site at
dirthat is not absolute and leads to no file of the site, or to noidon its page (spec §11). Pages in order of their paths, and each page’s links in order. - classify
- The block whose info string is
info, or an indented block forNone(3.5b spec §4.2). The info string is split at commas and whitespace into words, and empty words are dropped. - code_
blocks - Every code block of the Markdown
text, as the site finds them. - document_
package - Document the package whose
nova.tomlis inroot(empty for the current directory), its dependencies and std (spec §5.1). - document_
std - Document std alone (spec §4.1,
--std). - hidden
- For a hidden line of a Nova block (3.5b spec §4.3), where its
#, or its lone#, starts and how many bytes it is;Nonefor a line that shows. It runs less that mark. - hide_
lines markdownwith the hidden lines of its Nova blocks left out (3.5b spec §8.2), every other byte as it was. Hover shows docs through it.- package_
doc_ tests - The doc tests of the package whose
nova.tomlis inroot(spec §4.1), in the site’s order;Nonewhen it has no library. - std_
doc_ tests - std’s doc tests (spec §6.1,
--std), in the site’s order. - write_
site - Write
sitetodir, replacing a site written there before (spec §4.3). Returns the start page’s path.