MiCyteWiki
IndexRendered from README.md in the public repository. Edits belong there.
Purpose
docs/wiki/ explains how MiCyte works: its layers, applications, ports, network and the procedures for extending it. Normative rules are in docs/contracts/; authoring rules are in docs/standards/. When a wiki page starts stating a rule, the rule moves to a contract and the page links to it.
Status line
Every page has a > Status: line under its title:
| Status | Meaning |
|---|---|
as-built | The code works this way at the current commit. |
design-spec | The intended design; built parts are marked as built. |
how-to | Steps that work at the current commit. |
index | A list of other pages. |
stale | Known to be wrong in a stated way. |
Gates
fnd_app/tests/architecture/test_wiki_is_combed.py checks that the overview links every page exactly once, that every page has a status line and links the overview, that every markdown link resolves, and that every cited source path exists. fnd_app/tests/architecture/test_every_relative_doc_link_resolves.py checks relative links across the repository's documentation.