Repository navigation
🧹 chore: pre-release cleanups and polishes - #22
Merged
Merged
Conversation
Ahead of the v0.1.0 release, stop tracking internal process scaffolding (kept on disk locally via .gitignore, not deleted): - tasks/ (README marketing brainstorm) - docs/superpowers/ (brainstorm + design specs) - conductor/ (Conductor PM context: product, tech-stack, tracks) Preserve the two contributor docs CONTRIBUTING referenced by moving them to a tracked public home, with Conductor-internal wording scrubbed: - conductor/workflow.md -> docs/contributing/workflow.md (rewritten standalone) - conductor/code_styleguides/python.md -> docs/contributing/python-style.md CONTRIBUTING.md links updated to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mm-weber
marked this pull request as draft
June 15, 2026 22:12
Document all 14 MCP tools across the 3 servers (r2r, sourcebooks, vault-graph) in two parts: a practical per-tool reference (purpose, params, returns, behavior), then internals (transport/env, shared helpers, underlying R2R/graph calls, metadata schema, graph data model, reload-vs-rebuild, error model). Cross-linked from the README tools table and the quickstart. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…dth) Swap docs/images/architecture.svg to the white-background draw.io export (self-contained, all icons embedded) and widen the README image to 75%. The original diagram is retained at docs/images/architecture-v1.svg. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Adopt a two-view "Architecture" section in the README: - architecture-deployment.svg (renamed from architecture-v1.svg): what runs where, host vs hardened devcontainer, over host.docker.internal. - architecture-flow.svg (new draw.io export): how a request is answered. Names R2R/Postgres/pgvector, labels retrieval returns as chunks/notes/context and reserves "Answer" for Claude -> user, and surfaces OCR + Ollama on ingest. Drop the superseded single architecture.svg. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mm-weber
marked this pull request as ready for review
June 16, 2026 13:43
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
Polishes the public documentation surface and trims internal artifacts from the tracked tree. It splits the architecture diagram into a deployment view and a request-flow view, adds a full per-tool MCP reference, tightens the README,
refreshes the meta docs, and adds an Acknowledgments section.
Scope note: the v0.1 release tag and the hero/banner rollout are handled on a separate branch and are intentionally out of scope here. The hero header already lives in
main.Changes
Architecture & docs
docs/images/architecture-deployment.svg, renamed fromarchitecture.svg) and a new Request flow view (docs/images/architecture-flow.svg).docs/mcp-tools.md: a full per-tool reference (parameters, returns, internals) for the 3 MCP servers / 14 tools, linked from the README.docs/design.mdanddocs/quickstart.mdtouch-ups.README polish
Public-tree hygiene
conductor/(Conductor planning tracks),docs/superpowers/(plans + specs), andtasks/(working design docs).Meta / contributor docs
SECURITY.mdandCONTRIBUTING.md.docs/contributing/python.mdrenamed topython-style.md; addeddocs/contributing/workflow.md(moved out of the removedconductor/workflow.md).ATTRIBUTION.md.Acknowledgments