-
Notifications
You must be signed in to change notification settings - Fork 0
AGENTS
This repository is the canonical home for cross-project narrative documentation: setup, architecture, operating modes, testing, releases, and contributor workflows. Each topic is a root-level Markdown page such as Architecture.md, Getting-Started.md, or Testing-and-Verification.md. _Sidebar.md controls navigation and _Footer.md supplies shared footer content.
Keep exact environment-variable tables, deployment commands, and code-coupled runbooks in the owning code repository. Public privacy, support, accessibility, age-suitability, and data-deletion text belongs in the website repository; link to it rather than copying it.
The wiki has no compiled build or package dependencies. Validate changes with:
git diff --check
rg '\]\([^)]*\.md\)' .The first command catches whitespace errors. The second helps identify repository-style .md links that may need conversion to GitHub wiki page links. Preview changed Markdown in a renderer when editing tables, nested lists, or anchors.
Use clear sentence-case headings, short paragraphs, and descriptive link text. Do not manually hard-wrap prose; keep each sentence on one line and let the editor wrap it. Name pages with GitHub wiki-compatible hyphenated titles, for example Versioning-and-Releases.md. Avoid duplicating content: each fact should have one canonical location and other pages should link to it.
Check every changed internal link, heading anchor, table, and command example. When documenting implementation behavior, verify it against the current owning repository. Updates spanning app and backend behavior should describe boundaries explicitly and preserve the /api/v1 route terminology.
Use concise imperative commit subjects, commonly with a docs: prefix. Keep commits focused on one documentation concern. Pull requests should identify the behavior or workflow being documented, link the corresponding code change or issue, list pages reviewed, and call out any follow-up required in another repository.
Assume all wiki content is public. Never include credentials, tokens, private endpoints, user data, or unpublished operational details.
PumpSync documentation: iOS repository · Backend repository · Issues