M1: Create NERRF Documentation Website Using Fumadocs

[Itz-Agasta]

As part of M1, create a documentation website for NERRF using Fumadocs to centralize project details, serve the open-source community, and enhance visibility. This website will document the project’s progress up to the current implementation of the gRPC server, with plans to update it incrementally as new features (e.g., RocksDB writer, AI planner) are developed. Fumadocs, built on Next.js and Markdown, will provide a modern, searchable interface for users and contributors.

Key requirements:

• Document M0 deliverables (e.g., LockBit attack scenario, trace.proto schema).
• Detail M1 progress up to the gRPC server (e.g., eBPF tracepoints, streaming setup).
• Include setup guides, architecture overview, and contribution guidelines.
• Host on Vercel for public access.

Tasks

• Set up Fumadocs environment
• Create a docs/ folder with Markdown files for M0 (e.g., attack-scenario.md, trace-proto.md).
• Add M1 documentation up to gRPC server (e.g., eBPF-tracepoints.md, grpc-server.md).
• Configure Fumadocs with a custom theme (e.g., NERRF logo, dark mode).
• Write a setup guide (e.g., cloning repo, running tracker).
• Include an architecture diagram (e.g., eBPF → gRPC → RocksDB).

Acceptance Criteria

• Website renders M0 and M1 docs (up to gRPC server) without errors.
• Setup guide allows a new user to clone and run the tracker.
• Architecture diagram included
• Deployment accessible (e.g., https://itz-agasta.github.io/nerrf-docs).
• Responsive design works on desktop/mobile.
• OSS Readiness: Docs versioned (e.g., v0.1.0), CI pipeline includes build check.

References & Code Starting Point

• Fumadocs docs: Official guide fumadocs.vercel.app.
• Next.js deployment: Vercel guide vercel.com/docs.
• Starting Fumadocs config (adapt from template):

// docs/fumadocs.config.json
{
  "title": "NERRF Documentation",
  "description": "Docs for Neural Execution Reversal and Recovery Framework",
  "theme": {
    "palette": {
      "primary": "#1E3A8A",
      "secondary": "#10B981"
    }
  },
  "nav": [
    { "title": "Home", "href": "/" },
    { "title": "M0 Deliverables", "href": "/m0" },
    { "title": "M1 Progress", "href": "/m1" }
  ]
}