 |
libmemalloc 0.0.0-alpha
The Magic of Memory Transmutation
|
|
libmemalloc 0.0.0-alpha
The Magic of Memory Transmutation
|
Use the documentation guide for commands and dependency setup. scripts/check/documentation.lua confines task inventories to product SDD files. Its contract suite covers ordinary documents, product specifications and forbidden task inventories. Review rationale and evidence in issues and pull requests using the engineering review procedure.
Class: ANALYZABILITY. Obligation: project requirement.
The reusable lint workflow checks Actions, EditorConfig, C, Lua, Markdown, Mermaid, and applicable configuration or scripting languages. Validate the npm graph before using its documentation tools. Do not treat a missing required tool as an empty source selection.
Markdown checks cover repository documentation, including SDDs, examples, and workflow guides. Generated dependency directories and license texts are not authored Markdown. Preserve stable control anchors when rebuilding indexes. Do not replace broken evidence links with invented files or successful results.
Evidence: lint workflow, tool validation, and diagram validation.
Class: DOCUMENTATION. Obligation: project requirement.
Documentation is written in English. CSpell, codespell, typos, Vale, and Lychee have separate purposes; passing one does not replace the others. Inspect prose suggestions as well as blocking errors. Do not whitelist a misspelling simply to make a gate green. Add reviewed technical terms to the shared dictionary and regenerate its adapters.
Use descriptive reference titles. A reader must know the destination without decoding a numeric bibliography label. Keep requirement and test IDs because they identify contracts, not bibliographic entries.
The local link check runs on selected changes. External links are checked on default-branch pushes, manual runs, and releases. Offline success proves neither remote availability nor the truth of a cited claim.
Evidence: spelling workflow and shared dictionary generator.
Run the commands in the CI index, then Markdown, spelling, prose, link, license, and Actions validators with repository configurations. Include new, untracked documentation in the file inventory. Checks that read git ls-files need an isolated staged snapshot to inspect such files without changing the user's index.
Report each validator's status and its scope. Do not report all tests passing when a required validator was unavailable or when only a filtered subset ran.