Skip to content

🧹 chore: pre-release cleanups and polishes - #22

Merged
mm-weber merged 10 commits into
mainfrom
update-hero-and-architecture
Jun 16, 2026
Merged

mm-weber merged 10 commits into
mainfrom
update-hero-and-architecture

Conversation

@mm-weber

@mm-weber mm-weber commented Jun 15, 2026 •

Copy link
Copy Markdown
Owner

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

  • Split the single architecture diagram into two: a Deployment view (docs/images/architecture-deployment.svg, renamed from architecture.svg) and a new Request flow view (docs/images/architecture-flow.svg).
  • Rewrote the README Architecture section to walk both views (where things run vs. how a request is answered).
  • Added docs/mcp-tools.md: a full per-tool reference (parameters, returns, internals) for the 3 MCP servers / 14 tools, linked from the README.
  • Minor docs/design.md and docs/quickstart.md touch-ups.

README polish

  • Reformatted the "What you get" feature list from dense prose into scannable bulleted sub-lists.
  • Reworded the "What's not included" intro ("honest gaps" to "current gaps").

Public-tree hygiene

  • Removed internal development artifacts from the tracked/public tree and gitignored them so they remain on disk locally: conductor/ (Conductor planning tracks), docs/superpowers/ (plans + specs), and tasks/ (working design docs).
  • Net effect: roughly 1,750 lines of internal planning docs no longer ship in the public repo.

Meta / contributor docs

  • Revised SECURITY.md and CONTRIBUTING.md.
  • Reorganized contributing docs: docs/contributing/python.md renamed to python-style.md; added docs/contributing/workflow.md (moved out of the removed conductor/workflow.md).
  • Updated ATTRIBUTION.md.

Acknowledgments

  • New README section crediting Dustin Fennell for test-running the project on macOS with Docker Desktop and reviewing it.

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 mm-weber self-assigned this Jun 15, 2026
@mm-weber
mm-weber marked this pull request as draft June 15, 2026 22:12
mm-weber and others added 9 commits June 16, 2026 01:56
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 mm-weber changed the title chore: strip internal dev artifacts from the public tree chore: pre-release cleanups and polishes Jun 16, 2026
@mm-weber mm-weber changed the title chore: pre-release cleanups and polishes 🧹 chore: pre-release cleanups and polishes Jun 16, 2026
@mm-weber
mm-weber marked this pull request as ready for review June 16, 2026 13:43
@mm-weber
mm-weber merged commit 55114ea into main Jun 16, 2026
1 check passed
@mm-weber
mm-weber deleted the update-hero-and-architecture branch June 19, 2026 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant