Documentation generator
1 specification, 31 requirements. All libraries
0001 Docs
| Requirement | Mechanism | Who | Note |
|---|---|---|---|
FR-001 | check | bun run verify | library.test.ts: the folder, the manifest, the package and the spec kit agree |
FR-002 | check | bun run verify | package.test.ts: the entries a configuration imports are exported by name |
FR-003 | check | bun run verify | package.test.ts: the launcher runs build and check on a fixture and finds the configuration upward |
FR-004 | check | bun run verify | pack.test.ts: the package is packed with compiled modules, theme files, a launcher, a LICENSE and no link dependency |
FR-005 | check | bun run verify | consumer.test.ts: the packed package installed into an empty project builds and checks a small repository |
FR-006 | check | bun run verify | consumer.test.ts: a repository at another address has links to that address and names no other host |
FR-007 | check | bun run verify | book.test.ts: the presentations are web, markdown, data and book, the site is what is written without a choice, and a book needs its volumes; the command line takes --presentation (one or several, by name) and --check for build, and refuses them for check; the files of a presentation are written, a book into a folder that holds other things leaves them, and a file that is not what a build writes is found; build --presentation book without a volume is refused, and the book is written and checked from the command line |
FR-008 | check | bun run verify | book.test.ts: text that AsciiDoc would read as markup is passed through, a line that would be a list or a title begins safely, and a bracket is an attribute; every block is written: headings with anchors, lists, tables, code, callouts, entries, tabs, diagrams, cards and trees; a link to a page of the volume is a cross reference, to another is a link to the site where the book names one and its text where it does not; a volume is its parts' pages in the order of the navigation: a page is a chapter, a page under it a section, a page once, a part of each group, and a part that takes nothing is found; the files of a presentation are written, a book into a folder that holds other things leaves them, and a file that is not what a build writes is found |
FR-009 | check | bun run verify | evidence.test.ts: CTRF is read into tests with their requirements, a file that is not CTRF or not JSON is said so, and tickets of GitHub are read without pull requests and are tied to a library and requirements by label, path and words; evidence.test.ts: a configuration's evidence is checked, and a folder that is missing is no run, and a file that cannot be read is a finding |
FR-010 | check | bun run verify | evidence.test.ts: with a run recorded, the site has the Quality section, a line on each requirement, library and module, a finding for a test of a requirement that is not there, and the numbers in quality.json; evidence.test.ts: with no run recorded, no requirement is shown as passing, the pages say so, and a build with no evidence configured has no Quality section |
FR-011 | check | bun run verify | evidence.test.ts: with a run recorded, the site has the Quality section, a line on each requirement, library and module, a finding for a test of a requirement that is not there, and the numbers in quality.json; evidence.test.ts: with no run recorded, no requirement is shown as passing, the pages say so, and a build with no evidence configured has no Quality section; evidence.test.ts: the runs of the workflows are read from runs.json, and the Workflows page says how each ended, the last runs as marks, how long a run takes, which jobs failed, and what flaps; evidence.test.ts: the dashboard says which build this is and how the generator's own check ended, and a library with no report says why from what its job says; evidence.test.ts: the findings page says what the generator found while it made the site, by library, and that it found nothing where it did |
FR-012 | check | bun run verify | evidence.test.ts: the evidence tool runs a library's suite into CTRF the site reads, leaves meta.json, and refuses a library with no suite |
FR-013 | check | bun run verify | evidence.test.ts: the runs of the workflows are read from runs.json, and the Workflows page says how each ended, the last runs as marks, how long a run takes, which jobs failed, and what flaps; evidence.test.ts: the tool that reads the runs writes a file that says so where the API cannot be reached, and the emergency page is made from the evidence alone |
FR-014 | check | bun run verify | evidence.test.ts: the tool that reads the runs writes a file that says so where the API cannot be reached, and the emergency page is made from the evidence alone |
FR-015 | check | bun run verify | evidence.test.ts: a configuration's problems and a lens that throws are findings and the site is made without them |
FR-016 | check | bun run verify | evidence.test.ts: the history says how a library's tests moved over its runs: what began to fail, what was fixed, what keeps failing and what flaps, with trends, causes and the range of commits; evidence.test.ts: the history tool adds a run once, keeps the newest, and refuses evidence with no time |
FR-017 | check | bun run verify | evidence.test.ts: each library is held to the gate of the configuration, shown and enforced nowhere, and the requirements page says how each specification stands |
FR-018 | check | bun run verify | check.test.ts: the site of commons builds with no finding, the same twice, with its sections, the Quality section and the issues of data |
FR-019 | check | bun run verify | check.test.ts: the site of commons builds with no finding, the same twice, with its sections, the Quality section and the issues of data |
FR-020 | check | bun run verify | evidence.test.ts: the log of git is read into commits, the bus factor is how few authors made half of the commits, a file's last change is its newest commit, and a repository with no history is said to have none |
FR-021 | check | bun run verify | check.test.ts: the site of commons builds with no finding, the same twice, with its sections, the Quality section and the issues of data |
FR-022 | check | bun run verify | evidence.test.ts: line coverage is read from the lcov of bun, left to the library's source files, shown as a percent on the dashboard and as the least covered files on the library's page |
FR-023 | check | bun run verify | evidence.test.ts: the four measures of DORA are taken from the runs of the publishing workflow: publishes a day, the median minutes of a successful run, the share of runs that failed and the minutes from a failure to the next pass, and fewer than two runs give none |
FR-024 | check | bun run verify | highlight.test.ts: SQL is coloured by the lexer of the SQL language library |
FR-025 | check | bun run verify | evidence.test.ts: the tests that exercise an export are those of its package whose files import it, by the name it is exported under, and the API page of an export says how many there are and whether any fails |
FR-026 | check | bun run verify | evidence.test.ts: the open issues and tickets that name a file are on the page of the file, with a badge, and an issue's file evidence links back to the page of the file |
FR-027 | check | bun run verify | evidence.test.ts: the report of Stryker is read into the mutants killed, surviving and not run of each source file, the score is the share the tests detected, and the dashboard, the library's page and the file's API page show it |
FR-028 | check | bun run verify | evidence.test.ts: the changes since the tests ran are read from git's name-status, each path is source, test, specification or other, and with no history the page says so |
FR-029 | check | bun run verify | repo-ops.test.ts: the lens makes the Repo Ops pages from guides and typed facts, a page that cannot be read is a finding, and commons' site has the section with the workflows and every verb of repoctl |
FR-030 | check | bun test suite/ | findings.test.ts: the page, the counts, the accepted risks, the exports and the banner, from findings kept as the workflows write them |
FR-032 | check | bun run verify | evidence.test.ts: the package page shows the report against its budget, by kind and by library, the peers and each consumer, a file that is no report is a finding, and no report says how to make one |