Skip to content

docs: add .repo-docs directory#93

Open
vexa-tski wants to merge 2 commits intoSteelCompendium:mainfrom
vexa-tski:repo-docs
Open

docs: add .repo-docs directory#93
vexa-tski wants to merge 2 commits intoSteelCompendium:mainfrom
vexa-tski:repo-docs

Conversation

@vexa-tski
Copy link
Copy Markdown

Summary

  • Adds comprehensive .repo-docs/ directory with standardized documentation for the data-gen ETL pipeline
  • Covers project overview, architecture (pipeline stages, component map, data flow), development setup, integration map (14+ downstream repos), conventions, troubleshooting, and 4 architectural decision records
  • Generated from codebase analysis -- all commands, paths, and descriptions verified against actual repo contents

Files Added

File Description
index.md Overview, quick reference, repo structure, reading guide
project.md Domain context, glossary, feature inventory, constraints
architecture.md Pipeline stages, component map, data flow, dependencies
development.md Prerequisites, setup, common workflows, debugging
integration.md Upstream/downstream dependency map, data contracts
conventions.md Naming patterns, code style, commit conventions
troubleshooting.md Do-NOTs, known issues, common errors, debug playbooks
decisions/README.md Decision log index and ADR template
decisions/*.md 4 ADRs: HTML round-trip, Just orchestrator, SCC classification, multiple output variants

Test plan

  • Review generated docs for accuracy against current codebase
  • Verify all referenced commands and file paths exist
  • Confirm no sensitive information is included

🤖 Generated with Claude Code

Generates standardized documentation covering project overview, architecture,
development setup, integration map, conventions, troubleshooting, and
architectural decision records for the data-gen ETL pipeline.
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