DeepWiki – Manual Copilot Prompt Package

A prompt-driven documentation generator designed for enterprises that can’t use external LLM APIs. Works fully with GitHub Copilot Chat (agent mode) using simple copy & paste prompts.

---

Features

• Manual-first workflow → generate prompt blocks, paste into Copilot, paste results back.
• Evidence-driven → every claim must cite [S#] mapped to internal sources.
• Audit-friendly → pages include last_reviewed, owners, data_classification.
• Zero external calls → no repo scanning, no outbound API usage.
• Static site ready → Markdown outputs, viewable via MkDocs/Docusaurus.

---

Repo Structure

blueprints/     # Recipes defining steps & outputs
inputs/         # Curated internal docs (manual drop-in)
out/prompts/    # Generated prompt blocks for Copilot
pages/          # Final docs after pasting Copilot replies
prompts/        # System + section prompts
scripts/        # run.sh, generate_prompts.mjs, validate.mjs
validators/     # Schema + linkcheck rules
site/           # MkDocs config for preview/publish

---

Quick Start

1. Install deps (Node 18+):

   npm i

2. Add curated inputs to inputs/ (README, ADRs, runbooks, incidents, diagrams).

3. Generate prompt blocks:

   ./scripts/run.sh blueprints/service-doc.yml

   → Prompts saved in out/prompts/*.txt

4. Use Copilot manually:

   • Copy full block → paste in Copilot Chat.
   • Copy Copilot’s reply → save in the pages/ file shown in header.

5. Validate pages:

   npm run validate

6. (Optional) Preview with MkDocs:

   pip install mkdocs
   mkdocs serve

---

Validation Rules

• Front-matter schema must include:

  title: "<Service Name> – Overview"
  owners: ["team-example"]
  last_reviewed: "2025-08-19"
  sources: []
  data_classification: "Internal"
  changelog: []

• No unresolved TODO: lines.

• All non-obvious claims must cite [S#].

---

Workflow

1. Drop curated sources into inputs/
2. Run ./scripts/run.sh
3. Copy prompt → Copilot → paste reply into pages/
4. Run npm run validate
5. Open PR & review
6. Preview with mkdocs serve

---

Example Outputs

• pages/overview.md
• pages/architecture.md
• pages/operations.md
• pages/faq.md

Each page includes: Key Points, Quick Facts, ASCII diagrams, Sources & Evidence.

---

Enterprise Friendly

• No API dependencies.
• No repo-wide scanning — only curated inputs.
• Internal-only classification banners for compliance.

---

👉 Run your own DeepWiki-style internal documentation system with nothing but GitHub Copilot in agent mode.