Repository navigation
docs: public-facing README, usage and library guides for 0.4.0 - #3
Merged
Merged
Conversation
The repo is going public. Bring the end-user docs up to the current release and keep internal material out of the repository: - README rewritten: what grimoire is, the artifact vocabulary, 0.4.0 highlights (layered control plane, intent discovery, MCP server, OWASP audit, quality gates), install (git+https with extras), a quick start whose commands actually run (global options such as --set/--format precede the subcommand — the old examples put them after `conjure` and failed), library + layered + MCP snippets, a full CLI overview, doc links, development notes. The old README still described "Phase 0-2" from March. - docs/USAGE.md: fixed all misplaced --set examples, the broken LIBRARY.md link (-> AS_LIBRARY.md), install via git+https; added `rune audit`, `mcp serve`, sync importer options, `skill export --to` formats, and a "Layered Control Plane" section. - docs/AS_LIBRARY.md: new sections for the layered control plane (Grimoire.layered, strict loading, validate(layer=), caches, CompositeRepoView), intent discovery, the MCP tool manifest/server (build_app), OWASP metadata + federation; TOC, type reference and thread-safety notes updated; version appendix reorganised as "Feature Notes by Version" (0.4.0 / 0.3.0 / 0.2.0). - CHANGELOG: the pre-0.2.0 "[Unreleased]" block is now "[0.1.0]". - release_notes.md (an internal merge-prep note) removed from the repo; it now lives in the private docs tree under worklogs/. Every CLI and library example in the docs was executed against a `grimoire init` scaffold. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Copilot stopped reviewing on behalf of
araray due to an error
September 19, 2026 04:50
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prepares the repo for going public: end-user docs brought up to 0.4.0, internal material moved out.
conjure … --setexamples that fail because--set/--formatare global options that must precede the subcommand): vocabulary, 0.4.0 highlights, install viagit+https+ extras, runnable quick start, library / layered / MCP snippets, CLI overview, doc links.--set, the brokenLIBRARY.mdlink, install; addedrune audit,mcp serve, sync importer options,skill export --to, and a Layered Control Plane section.build_app), OWASP + federation; TOC/type reference/thread-safety updated; "Feature Notes by Version" (0.4.0 / 0.3.0 / 0.2.0).[Unreleased]block labelled[0.1.0].docs/grimoire/worklogs/release_notes_0.3.0_june-2026.md). Specs, worklogs and plans stay there too — nothing internal remains in this repo.Verification
Every CLI and library example in the three documents was executed against a fresh
grimoire initscaffold (conjure in text/openai/provenance modes,spell vars,rune audit,prompt lint,bind --dry-run,skill list,sync drift,Grimoire.layered,validate(layer=),find_by_intent,find_tools_by_intent,to_mcp_tool_manifest). No code changes.🤖 Generated with Claude Code