Skip to content

Home

Jump to bottom
Azahari Zaman edited this page Jun 27, 2026 · 1 revision

Paxman Wiki

Welcome! This is the Paxman project wiki — a public, editable knowledge base for internal development history and forward-growth documentation that does not belong in the main repo.

What's in this wiki

The wiki has two top-level areas:

📁 Internal Development

The complete development history of Paxman V1: sprint plans, retrospectives, delivery audits, the V1 acceptance criteria, the original PRD, the license-decision analysis, and historical release notes. This is the "why we built it this way" archive.

This content is public so any contributor can answer "why was this decision made?" by reading the relevant wiki page. The wiki is a separate git repo from the main paxman code, so it can be edited by anyone with repo write access without polluting the source tree.

🛠 Other articles

Forward-growth articles, persona-specific walkthroughs, integration recipes, and any other documentation that does not fit the categorized docs on Read the Docs.

How to edit this wiki

  1. Click any page title above to view it.
  2. Click Edit in the top right to edit the markdown.
  3. The wiki is a git repo at nexusnv/paxman.wiki. Edits are committed to that repo.

Source-code hyperlinks

Every wiki page that references source code uses a link of the form https://github.com/nexusnv/paxman/blob/<commit-or-tag>/src/paxman/foo.py#L10-L20. The commit SHA at the bottom of each sprint page records the merge commit of that sprint, so links are stable and remain valid even if the code is later refactored.

When to add to this wiki

  • Internal development history that should be public-but-archive: sprint plans, retrospectives, audits, the original PRD.
  • Forward-growth guides that don't fit the docs site's Diátaxis structure yet.
  • Long-form articles that don't suit a structured doc site.

When not to add to this wiki

  • User-facing documentation. That goes on Read the Docs.
  • Contributor workflow docs. Those are at docs/contributing/.
  • Anything that changes every release. Wikis are for stable, archival content; the changelog is in the main repo.

See also

Clone this wiki locally