Skip to content

docs(maproom): Postgres backend accuracy pass — plugin 0.10.2 - #67

Open
danielbushman wants to merge 2 commits into
maproom-plugin-critical-fixesfrom
maproom-plugin-docs-refresh
Open

danielbushman wants to merge 2 commits into
maproom-plugin-critical-fixesfrom
maproom-plugin-docs-refresh

Conversation

@danielbushman

Copy link
Copy Markdown
Member

Summary

  • Adds Postgres backend documentation to the maproom plugin: connectivity troubleshooting section, Storage Backend glossary entry, SQLite-scoped annotations on GAP-004/005/006, updated version floor to 0.2.0, and an INTERIM multi-repo block fenced against the unshipped --all-repos flag.
  • Bumps plugin version to 0.10.2 (PATCH — docs only).

What changed

File Change
.claude-plugin/plugin.json Version 0.10.1 → 0.10.2
agents/maproom-researcher.md Version floor 0.1.0 → 0.2.0; INTERIM multi-repo block; embedding-absent guidance
skills/maproom-guide/references/concept-glossary.md New Storage Backend entry (SQLite vs Postgres, portable phrasing, PG14 test vs PG16 live)
skills/maproom-search/references/troubleshooting.md New Postgres Connectivity Issues section; version comment 0.1.0 → 0.2.0; portable Connection String example
README.md Minimum version 0.1.0 → 0.2.0 at all three occurrences
scripts/monthly-cli-verification.sh EXPECTED_VERSION 0.1.0 → 0.2.0

Spec

_SPECS/crewchief/research/maproom-eco-plugin-backend-docs-refresh-spec.md

Validation evidence

  • bash plugins/maproom/scripts/verify-docs.sh → 11/11 PASS
  • bash plugins/maproom/scripts/monthly-cli-verification.sh → No DRIFT (Check 2: Version matches expected 0.2.0)
  • maproom --version → maproom 0.2.0
  • Live shared backend confirmed PostgreSQL 16 (pgvector/pgvector:pg16) via psql SELECT version()
  • In-container test DB confirmed PG14 via psql localhost:5433/maproom_test

Review findings resolved / deferred

MUST-FIX — all resolved:

  1. monthly-cli-verification.sh EXPECTED_VERSION 0.1.0 → 0.2.0 — FIXED
  2. README.md minimum version 0.1.0 at lines 37, 183, 202 — FIXED (all three occurrences updated to 0.2.0)
  3. concept-glossary.md "In this devcontainer" + PG14 misidentification of shared backend — FIXED (prose now says "In shared-Postgres devcontainer setups"; addresses marked as e.g.; PG16 noted for shared backend)
  4. troubleshooting.md Connection String Expected: showing devcontainer-only URL as canonical — FIXED (placeholder postgres://user:pass@host:port/dbname is now the Expected value; devcontainer form added as a labelled example)

SHOULD-FIX — all resolved (cheap and clearly correct):

  1. troubleshooting.md quick-check version comment 0.1.0 → 0.2.0 — FIXED
  2. troubleshooting.md docker ps --filter name=maproom-postgres — FIXED (inline comment added: "replace maproom-postgres with your actual container name")

NOTE findings — deferred (informational, DoD does not require action):

  • Docker socket permission note (newgrp docker): Correct diagnostic for the devcontainer environment; adding a note would increase noise in a section aimed at diagnosing maproom errors, not container permission issues. Deferred.
  • Behavioral E2E tests NOT EXECUTED: Spec (size M, doc-only) does not require automated E2E coverage. Hook unit tests 11/11 pass. Deferred.

Non-goals

  • No changes to hooks, skills structure, or agents beyond the specified scope items.
  • No --all-repos usage (unshipped flag); INTERIM block is fenced.
  • No DDL or writes against the live shared Postgres index.

🤖 Generated with Claude Code

danielbushman and others added 2 commits July 9, 2026 22:22
- concept-glossary.md: expand SQLite entry to cover both backends;
  describe shared-Postgres via MAPROOM_DATABASE_URL, note localhost:5433
  as cargo-test-only sandbox, maproom status as canonical probe
- troubleshooting.md GAP-004/005/006: add "SQLite backend only" banners;
  add Postgres Connectivity Issues section (health check, connection string,
  common error table, FTS-vs-embeddings note)
- embedding-providers.md + adc-setup.md: add status banners noting
  embeddings not generated by default in shared-PG; FTS operative; docs
  remain valid when embeddings are enabled
- README.md L42 + L114: reframe database-location as backend-agnostic
  (MAPROOM_DATABASE_URL / maproom status); retain SQLite path for SQLite users
- maproom-researcher.md: version floor 0.1.0 → 0.2.0; add INTERIM
  multi-repo tasks subsection (status --json enumeration, per-repo loop,
  maproom-all as local convenience, --repo specs availability, no --all-repos)
- plugin.json: 0.10.1 → 0.10.2 (PATCH per repo convention)
- verify-docs.sh: 11/11 checks pass

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Bump EXPECTED_VERSION in monthly-cli-verification.sh from 0.1.0 to 0.2.0
  (was causing immediate DRIFT on every scheduled CI run)
- Update README.md minimum version floor from 0.1.0 to 0.2.0 at all three
  occurrences (lines 37, 183, 202) — eliminates intra-plugin contradiction
  with researcher.md's 0.2.0 requirement
- Fix concept-glossary.md Storage Backend entry: remove devcontainer-specific
  prose ("In this devcontainer"), correct shared backend from PG14 to PG16,
  make addresses illustrative ("e.g.") rather than normative
- Fix troubleshooting.md Connection String section: replace
  "Expected: <devcontainer-URL>" with a portable placeholder; add devcontainer
  form as a labelled example only
- Fix troubleshooting.md quick-check block: bump version comment 0.1.0→0.2.0
- Add inline note that the docker container name is environment-specific

verify-docs.sh: 11/11 PASS; monthly-cli-verification.sh: no DRIFT

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 869174b2-c388-48c0-bec4-8c59fd7e3f05

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch maproom-plugin-docs-refresh

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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