ADFA-5107: Add Claude-facing reference for the documentation database

[davidschachterADFA]

Summary

• Adds docs/documentation-database.md, combining the Confluence design doc for documentation.db (Tier 1/2/3 help) with docdb-studio's CLAUDE.md/SCHEMA.md, cross-checked against WebServer.kt, ToolTipManager.kt, and PluginDocumentationManager.kt so it reflects actual consumer behavior.
• Links the new doc from ARCHITECTURE.md's persistence-policy callout and from ADR 0001's raw-SQLite exceptions table, so it's discoverable from paths already read for architecture/persistence questions.

Test plan

• Docs-only change; no build/test impact.
• spotlessCheck passed via the pre-push hook.

🤖 Generated with Claude Code

[claude]

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.

_{Tip: disable this comment in your organization's Code Review settings.}

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d859f1ab-bf6e-4b82-b717-c2a5e5c8e1f3

📥 Commits

Reviewing files that changed from the base of the PR and between cb4e02f and 1dc907c.

📒 Files selected for processing (2)

• ARCHITECTURE.md
• docs/documentation-database.md

🚧 Files skipped from review as they are similar to previous changes (2)

• ARCHITECTURE.md
• docs/documentation-database.md

---

📝 Walkthrough

• Added docs/documentation-database.md with the documentation.db schema, behavior, lookup semantics, integration points, editing workflow, and known limitations.
• Documented tooltips, in-app/plugin help, and the local web server as database consumers.
• Clarified Tier 1 and Tier 2 tooltip content and Tier 3 web content behavior.
• Corrected the Content.UNIQUE(path) duplicate-path behavior.
• Linked the new reference from ARCHITECTURE.md and ADR 0001.
• Documentation-only change. No build or test impact.
• spotlessCheck passed through the pre-push hook.
• Risk: The documentation can become outdated if the schema or consumer behavior changes without corresponding updates.

Walkthrough

The change documents the read-only documentation.db database, its schema, query patterns, integration points, editing workflow, limitations, and related architecture references.

Changes

Documentation database guidance

Layer / File(s)	Summary
documentation.db reference docs/documentation-database.md	Documents database paths, debug overrides, schema tables, lookup semantics, query patterns, integrations, editing rules, and limitations.
Architecture and ADR references ARCHITECTURE.md, docs/adr/0001-prefer-room-for-persistence.md	Links tooltip, plugin-help, and local web-server consumers to the shared database documentation.

Estimated code review effort: 2 (Simple) | ~10 minutes

Mergeability Score: ⚪ Minimal · up to 1dc90

This PR adds and cross-links documentation without changing product behavior or runtime code, so no actionable merge-blocking risk remains after normal checks and review.

Poem

A rabbit hops through tables bright,
With schema maps to guide the night.
Tooltips, help, and servers agree,
Their shared docs bloom beside the tree.
documentation.db rests clear and neat.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the documentation change for the documentation database and matches the main purpose of the pull request.
Description check	✅ Passed	The description accurately summarizes the new documentation, cross-references, corrections, and docs-only scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch task/ADFA-5107-docdb-notes

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ARCHITECTURE.md`:
- Around line 106-107: Update the documentation database reference sentence in
ARCHITECTURE.md to include the in-app/plugin-help consumer alongside tooltips
and local-web-server exceptions. Preserve the existing documentation.db
description and link, and ensure PluginDocumentationManager.kt is represented as
a consumer.

In `@docs/documentation-database.md`:
- Line 3: Update the opening description in the documentation database reference
to state that tooltips provide Tier 1/2 content, while Tier 3 content is served
by WebServer and linked from the tooltips. Keep the existing database ownership
and scope guidance unchanged.
- Line 38: Update the uniqueness description in the documentation near the
existing UNIQUE(path) schema declaration to state that duplicate paths are
currently rejected even when languageID differs. Clarify that composite
uniqueness on path and languageID is the future upstream schema change, and
align the later uniqueness statement so both sections describe the current
constraint consistently.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c86ec2de-239f-48f4-9f9e-ca7aa3e9e259

📥 Commits

Reviewing files that changed from the base of the PR and between ffb63dd and cb4e02f.

📒 Files selected for processing (3)

• ARCHITECTURE.md
• docs/adr/0001-prefer-room-for-persistence.md
• docs/documentation-database.md