Skip to content

Docs/comprehensive documentation - #1

Merged
OfficialRuby merged 2 commits into
mainfrom
docs/comprehensive-documentation
Jul 19, 2026
Merged

Docs/comprehensive documentation#1
OfficialRuby merged 2 commits into
mainfrom
docs/comprehensive-documentation

Conversation

@OfficialRuby

Copy link
Copy Markdown
Contributor

No description provided.

Expand the terse design docs into a full, layered documentation site that
teaches VAPN from first principles (no networking background assumed) and
guides every audience from beginner to advanced operator.

New sections:
- Documentation home with per-audience navigation paths
- Getting Started (quickstart, install, update, uninstall, FAQ, troubleshooting)
- Core Concepts (Internet/IP/CIDR, ASN, BGP, RIPE/RIS/MRT, GeoIP, consensus/trust)
- Walkthroughs (end-to-end trace + install, publishing, auth, measurement,
  trust, updates)
- RIPE Routing Builder deep-dive + simplified install guide
- Community Workers (overview, install, command reference, lifecycle,
  resources/privacy)
- Django integration guide (models, endpoints, tasks, admin, testing, rollout)
- API Reference (coordinator, VPS Advisor, admin surfaces)
- Development guide and Reference (CLI, configuration, schema, glossary)
- Project Handbook: the whole system as one book, PDF-exportable

Also:
- Route worker install through the canonical GitHub install.sh; drop the
  install.vpsadvisor.com vanity URL everywhere
- Remove the redundant concise integration guide (superseded by the Django
  guide); repoint all references
- Wire the existing architecture/operations/demos docs into the new site
@OfficialRuby
OfficialRuby merged commit 8c9e4b2 into main Jul 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant