Skip to main content

Phase 0: Documentation Site

Stand up the documentation site at doc.redactedworld.com so that every subsequent phase has a living reference for design decisions, implementation progress, and operational runbooks.

Prerequisites

None -- this is the first phase.

Blocks

IDBlockDescriptionAcceptance Criteria
0.1Scaffold Docusaurus projectInitialize a Docusaurus 3 project under docs-site/ with TypeScript config, the classic preset, and a custom dark-hacker theme that matches the RedactedWorld brand.npx docusaurus build succeeds; local dev server renders the landing page with correct branding.
0.2Design docs contentWrite the design documentation pages covering architecture overview, services, data stores, infrastructure, authentication, theming, domain verification, pentesting tools, and job execution.All pages listed in the sidebar under "Design" render without errors and contain substantive content (no placeholders).
0.3Implementation plan pagesCreate this set of plan pages -- an index plus one page per phase (0-8) -- with block tables, acceptance criteria, and dependency information.All 10 plan pages render; the index table lists all 9 phases with correct block counts.
0.4Progress tracker componentBuild a React component that reads a JSON progress file and renders phase/block completion status with progress bars. Embed it on the plan index page.Component renders on the plan index; updating the JSON file changes the displayed progress without a code change.
0.5Dockerfile & K8s manifestsWrite a multi-stage Dockerfile (node:20-alpine build, nginx:alpine serve) and Kubernetes manifests (Deployment, Service, IngressRoute) for doc.redactedworld.com.docker build succeeds; kubectl apply creates the resources; the site is reachable at the target URL inside the cluster.
0.6Deploy to doc.redactedworld.comDeploy the documentation site image to the cluster behind Traefik and verify it is publicly accessible.curl -s -o /dev/null -w "%{http_code}" https://doc.redactedworld.com returns 200.

Estimated Scope

AreaFiles / Resources
Repositorydocs-site/ directory (Docusaurus project root)
Docs contentdocs-site/docs/design/*.md, docs-site/docs/plan/*.md
React componentsdocs-site/src/components/ProgressTracker/
Containerdocs-site/Dockerfile
Kubernetesk8s/docs-site/deployment.yaml, k8s/docs-site/service.yaml, k8s/docs-site/ingressroute.yaml