diff --git a/README.md b/README.md index d94a832..ab62ded 100644 --- a/README.md +++ b/README.md @@ -39,17 +39,23 @@ https://github.com/3leaps/crucible/ (browse or raw files) ### Local Fallback -When network access is unavailable: +When network access is unavailable, clone +[`3leaps/crucible`](https://github.com/3leaps/crucible) as a sibling of the +consuming repository: ```bash -# Clone as sibling to your project -cd ~/dev -git clone https://github.com/3leaps/crucible.git +# From the consuming repository +git clone https://github.com/3leaps/crucible.git ../crucible # Reference via relative path ../crucible/docs/coding/baseline.md ``` +This catalog is `3leaps/crucible`. Other GitHub organizations also publish a +repository named `crucible` (for example +[`fulmenhq/crucible`](https://github.com/fulmenhq/crucible)). Use the +org-qualified URL above so the sibling named `crucible` is this catalog. + **Convention**: 3leaps tools check for `../crucible/` as a fallback when GitHub is unreachable. ### Access Priority diff --git a/docs/getting-started.md b/docs/getting-started.md index d6d25d7..7acfda1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -5,6 +5,7 @@ author: "Claude Opus 4.5" author_of_record: "Dave Thompson " supervised_by: "@3leapsdave" date: "2025-12-26" +last_updated: "2026-08-21" status: "draft" tags: ["getting-started", "onboarding", "adoption"] --- @@ -44,14 +45,19 @@ Crucible is a lightweight standards baseline covering: | 2 | `../crucible/docs/` | Local sibling clone (offline) | | (planned) | `https://crucible.3leaps.dev/` | Hosted docs site (targeted v0.1.x) | -**For development**, clone crucible as a sibling for fast offline access: +**For development**, clone +[`3leaps/crucible`](https://github.com/3leaps/crucible) as a sibling of the +consuming repository: ```bash -cd ~/dev # or your org's dev folder -git clone https://github.com/3leaps/crucible.git -# Now accessible at ../crucible/ from any sibling repo +# From the consuming repository +git clone https://github.com/3leaps/crucible.git ../crucible +# Now accessible at ../crucible/ ``` +This catalog is `3leaps/crucible`. Other GitHub organizations also publish a +repository named `crucible`. + ### When Local Copies Are Required Most Crucible content is **guidance for humans and processes**—commit style, coding conventions, agent protocols. These are referenced, not embedded. diff --git a/docs/guides/agentic-interface-adoption.md b/docs/guides/agentic-interface-adoption.md index 90d75cf..10f23d8 100644 --- a/docs/guides/agentic-interface-adoption.md +++ b/docs/guides/agentic-interface-adoption.md @@ -5,7 +5,7 @@ author: "Claude Opus 4.5" author_of_record: "Dave Thompson " supervised_by: "@3leapsdave" date: "2026-01-01" -last_updated: "2026-01-01" +last_updated: "2026-08-21" status: "approved" category: "guide" tags: ["agentic", "adoption", "roles", "attribution", "migration"] @@ -89,20 +89,23 @@ your-repo/ ### Path 3: Selective Role Adoption -Copy only the roles you need: +Copy only the roles you need. These commands assume the consuming repository +is the current directory and that +[`3leaps/crucible`](https://github.com/3leaps/crucible) is cloned as a sibling +named `crucible`: ```bash # Create directories mkdir -p config/agentic/roles schemas/upstream/3leaps/agentic/v0 # Copy schema -cp ~/dev/crucible/schemas/agentic/v0/role-prompt.schema.json \ +cp ../crucible/schemas/agentic/v0/role-prompt.schema.json \ schemas/upstream/3leaps/agentic/v0/ # Copy selected roles -cp ~/dev/crucible/config/agentic/roles/devlead.yaml \ +cp ../crucible/config/agentic/roles/devlead.yaml \ config/agentic/roles/ -cp ~/dev/crucible/config/agentic/roles/devrev.yaml \ +cp ../crucible/config/agentic/roles/devrev.yaml \ config/agentic/roles/ ``` diff --git a/docs/operations/upstream-sync-guide.md b/docs/operations/upstream-sync-guide.md index dfb6ee6..ccb91f9 100644 --- a/docs/operations/upstream-sync-guide.md +++ b/docs/operations/upstream-sync-guide.md @@ -56,7 +56,7 @@ Content vendored from external repositories. To update vendored content: -1. Check latest commit: `cd ~/dev/crucible && git log -1` +1. Check latest commit: `(cd ../crucible && git log -1)` 2. Copy updated files to `schemas/upstream/3leaps/` 3. Update this PROVENANCE.md with new commit hash 4. Run `make upstream-validate` to verify @@ -66,8 +66,8 @@ To update vendored content: ### 3. Copy the schema files ```bash -# From 3leaps/crucible, copy the schema -cp ~/dev/crucible/schemas/agentic/v0/role-prompt.schema.json \ +# From the consuming repository, with 3leaps/crucible cloned as a sibling +cp ../crucible/schemas/agentic/v0/role-prompt.schema.json \ schemas/upstream/3leaps/agentic/v0/ # Verify it copied correctly @@ -129,17 +129,16 @@ name: Development Lead When 3leaps/crucible updates and you want the new version: ```bash +# From the consuming repository, with 3leaps/crucible cloned as a sibling + # 1. Check what changed upstream -cd ~/dev/crucible -git pull -git log --oneline -5 +(cd ../crucible && git pull && git log --oneline -5) # 2. Copy updated files -cp schemas/agentic/v0/role-prompt.schema.json \ - ~/dev/your-repo/schemas/upstream/3leaps/agentic/v0/ +cp ../crucible/schemas/agentic/v0/role-prompt.schema.json \ + schemas/upstream/3leaps/agentic/v0/ # 3. Update PROVENANCE.md with new commit hash -cd ~/dev/your-repo # Edit schemas/upstream/3leaps/PROVENANCE.md # 4. Validate @@ -207,7 +206,7 @@ The upstream schema may have new required fields. Check: ```bash # See what changed diff schemas/upstream/3leaps/agentic/v0/role-prompt.schema.json \ - ~/dev/crucible/schemas/agentic/v0/role-prompt.schema.json + ../crucible/schemas/agentic/v0/role-prompt.schema.json # Update your config files to match new schema requirements ```