#Writing documentation
The manual is Markdown in docs/, rendered into a static site by the panel's own builder. No third-party generator, no network access, no npm: the same Python that runs the platform renders the pages.
aegis docs build # docs/ → public/docsaegis docs build --out /tmp/siteaegis docs web # build, then serve on a free portThe builder reports how many pages it wrote and prints the entry point.
#Adding a page
docs/<name>.md. Start with a single # Title — it becomes the pagetitle and the browser tab.
app/modules/docs/pages.py: a `Page(source, title,href)` inside the section it belongs to.
docs/README.md.aegis docs build.A file that is missing from the sidebar is not lost: it is appended under an "Other" section, in file order. That is a safety net, not an arrangement — write the order by hand, because that is what a reader follows.
#What the parser understands
The subset GitHub also renders, and nothing beyond it:
# … ###### headings; ## and ### also build the table of contents;bash, `ini, ``json get syntaxhighlighting);
--- separator;>), horizontal rules (---); code , bold, italic and links`.Anything else stays a paragraph — the parser fails safe instead of guessing.
#Links
Write links as if you were on GitHub: [tasker](tasker.md). The builder rewrites every *.md target to the generated .html page, so the same text works in the repository and on the site. External URLs are left alone.
Anchors come from the headings (## Live feed → #live-feed), so a link to a section is live.md#live-feed.
#Style
# per page. Short sections; a table for anything with more than twocolumns; a code block for anything an operator types.
a reference that never says which value to choose is not much help.
page: it teaches something false with confidence.
/aegis/data/www), real commands, theoutput shape the panel actually returns.
#Where each topic lives
| Topic | Page |
|---|---|
| installation, architecture, configuration | top level |
| command line, keeper, tasker, permissions, live feed | Operations section |
| one application and its cube | cubes/<name>.md |
| the panel and its JSON API | panel.md, api.md |
| panel internals (routes, templates, components) | panel-development.md |
| errors already met | troubleshooting.md |
| what is next | roadmap.md |
#Files
| Path | Content |
|---|---|
docs/ | the sources, one file per page |
app/modules/docs/pages.py | sidebar order and section names |
app/modules/docs/markdown.py | the parser |
app/modules/docs/highlight.py | the shell/ini/json highlighter |
app/modules/docs/theme.py, script.py | stylesheet and script served with the site |
public/docs/ | generated output; rebuild it, do not edit it |
The builder writes every page and never deletes: a document removed from docs/ leaves its generated HTML behind until the output directory is cleaned. Treat public/docs as disposable output, never as the source.