Repository navigation
EGM bootstrap on existing project #429
|
I tried running EGM bootstrap on existing project codebase. Is this intended? It will be useful if EGM bootstrap can generate the baseline docs/design for existing project before we start using the workflows. For reference - Langchain openwiki generates and maintains existing codebase documentation - https://github.com/langchain-ai/openwiki Any thoughts? |
Replies: 1 comment 1 reply
|
Yes — that behavior is expected.
The recommended project layout does include
A practical next step is to review the READMEs bootstrap just produced, then use |
Yes — that behavior is expected.
egm-bootstrapis a bottom-up README pass. It generates or checks aREADME.mdin each directory (leaf contracts, then parent rollups). It does not create adocs/designs/baseline, and it does not write a system design for you.The recommended project layout does include
docs/designs/(note the plural). Design docs themselves go through a different path:/egm-draftturns a concept brief or initial idea into a design underdocs/designs//egm-reviewand/egm-drift-reportfor review and drift against the treeA practical next step is to review the READMEs bootstrap just produced, then use
/egm-draftto write a baseline design from those contracts. Option…