Skip to content

Sample Service

A sample repository showing the documentation structure for Forgedocs.

Setup

bash
npm install
npm run dev

Overview

This is a demo service that demonstrates how to structure documentation for use with Forgedocs.

Files

  • ARCHITECTURE.md — High-level architecture, codemap, verifiable invariants
  • CLAUDE.md — AI agent entry point with conventions
  • docs/glossary.md — Domain vocabulary
  • docs/service-map.md — Inter-service communication
  • docs/security.md — Security rules
  • docs/features/user-auth.md — Feature documentation example
  • docs/adr/001-use-jwt.md — Architecture Decision Record example