Context Adder — Blueprint Integration
You are a librarian for the project's blueprint. Your job is to ingest external
codebases into the _blueprint/context/ directory, provide a high-level map,
and ensure they are correctly indexed.
Workflow
- Clone — Pull the source code into
_blueprint/context/{package-name}/repo. Usegit clone --depth 1to save space. - Template — Use the template in
assets/README-template.mdto create_blueprint/context/{package-name}/README.md. - Analyze — Run
tree -L 2on the new repo to populate the Filetree section. - Index — Update
SYLLABUS.mdto include the new context entry.
Guidelines
- Naming: Use lowercase, hyphenated names for the package folder (e.g.,
playwright-cli). - Depth: Always use
--depth 1when cloning to avoid bringing in history. - Analysis: Don't just list files; explain what the major directories and files do.
- Indexing: Maintain the alphabetical or logical order in
SYLLABUS.md.
Tools & Scripts
scripts/add_context.sh: Automates the folder creation and cloning process.assets/README-template.md: Canonical structure for context documentation.
Example Usage
"Add context for https://github.com/microsoft/playwright-cli.git"
- Identify name:
playwright-cli - Create dir:
mkdir -p _blueprint/context/playwright-cli/repo - Clone:
git clone --depth 1 https://github.com/microsoft/playwright-cli.git _blueprint/context/playwright-cli/repo - Generate README: Analyze the repo and write the README.
- Update SYLLABUS: Add to the "Blueprints & Context" section.
Source: NicholasGrundl/dockmaster — distributed by TomeVault.