Skip to content

Internal Development

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

Internal Development

Audience: Paxman maintainers and contributors who need to understand the why behind the V1 codebase. All content here is public for transparency, but it is archival — not user-facing.

This wiki area is the historical record of how Paxman V1 was built: sprint plans, retrospectives, internal audits, the original PRD, the V1 acceptance criteria, the license-decision analysis, and historical release notes. The wiki replaced the in-repo docs/sprints/, docs/reports/, and a handful of top-level files in Sprint 11 (post-v1 repo springclean).

How this is organized

Section What's there Why
Release Roadmap One-page index of all V1 sprints in order Quick orientation for new contributors
Sprints (10 pages) Per-sprint plan: scope, deliverables, exit criteria, risk register Each sprint links to the merge commit of its PR for stable code refs
Retrospectives V1.0.0 retrospective Sprint 10 outcome
Reports & Audits (5 pages) Performance baseline, cross-platform verification, bandit/pip-audit, OIDC setup, sprint delivery audit The "is it production-ready?" evidence trail
Decision History (4 pages) License decision full analysis, V1 acceptance criteria, original PRD, CHANGES_LOG, Sprint plan The "why did we make this choice?" archive
Old Releases (1 page) v0.5.0 release notes Pre-V1 history

Why this is on the wiki, not in the repo

The content here is:

  • Large (5,000+ lines of sprint plans, retros, audits)
  • Archival (does not change once written)
  • Public-but-archive (contributors should be able to read it, but forkers don't need it)
  • Cross-linked to source code (each sprint page links to the merge commit of its PR)

The paxman source repo should contain only what a forker needs to build and use the library. This wiki contains the development process that produced it. Keeping them in separate repos also lets the maintainer team edit this content without going through a PR review on the main library repo.

How to link here from the main repo

When a source-code comment or docstring references a wiki page, the URL is:

https://github.com/nexusnv/paxman/wiki/Internal-Development/<Page-Name>

GitHub auto-slugs page names: spaces become hyphens, special characters are stripped. Example: Sprint 3 — Planner & capabilities becomes Sprint-3-—-Planner-&-capabilities.

See also

Clone this wiki locally