Skip to content

ADFA-5235: Document sibling repos and documentation.db provenance - #2107

Open
hal-eisen-adfa wants to merge 1 commit into
stagefrom
task/ADFA-5235-claude-md-repos-docdb-provenance
Open

hal-eisen-adfa wants to merge 1 commit into
stagefrom
task/ADFA-5235-claude-md-repos-docdb-provenance

Conversation

@hal-eisen-adfa

@hal-eisen-adfa hal-eisen-adfa commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

ADFA-5235

Docs only. This teaches Claude, and readers, where large assets and documentation.db come from, so fewer mistakes come from trusting a stale local copy.

  • CLAUDE.md: a short "Sibling repos" list: addons, dev-assets, OfflineDocumentationTools.
  • ARCHITECTURE.md: a new "Sibling Repositories & Asset Provenance" section:
    • dev-assets stores the Asset(...) blobs as split parts and serves them at appdevforall.org/dev-assets/.
    • Google Drive holds the canonical documentation.db. CI reads it from Drive in compress_docdb.yml, release.yml and generate_assets.yml.
    • Local builds get the dev-assets copy, which is updated by hand and can lag Drive.

Checked against app/build.gradle.kts (Asset(...) list, scp path), the three workflows, strings.xml (url_discover_plugins), the plugin-api-latest release, and the three repos via gh.

Dead code found along the way is filed separately as ADFA-6376.

CLAUDE.md lists the three sibling repos (addons, dev-assets,
OfflineDocumentationTools). ARCHITECTURE.md explains how they feed the
build: dev-assets serves the Asset(...) blobs, Google Drive holds the
canonical documentation.db that CI reads, and local builds use the
hand-updated dev-assets copy, which can lag Drive.

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

coderabbitai Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 29bf1d9b-8a31-4e62-9eb4-8ee3b996487f
📥 Commits

Reviewing files that changed from the base of the PR and between 1c33961 and 8355b3b.

📒 Files selected for processing (2)
  • ARCHITECTURE.md
  • CLAUDE.md

Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


📝 Summary
  • Added a CLAUDE.md section linking the addons, dev-assets, and OfflineDocumentationTools sibling repositories.
  • Added an ARCHITECTURE.md section describing asset storage and delivery, repository roles, and documentation.db provenance. It distinguishes the Google Drive source used by CI from the manually updated dev-assets copy used by local builds.
  • Risk: The local documentation.db copy can lag behind Google Drive. Keep this distinction current as the asset workflows change.
  • The changes are documentation-only. Test results and current review findings were not provided.

Walkthrough

The documentation names three related repositories and describes how build assets and documentation.db are sourced and used in local and CI workflows.

Changes

Repository and Asset Provenance

Layer / File(s) Summary
Repository relationships and asset provenance
CLAUDE.md, ARCHITECTURE.md
CLAUDE.md names the related repositories and points to ARCHITECTURE.md. ARCHITECTURE.md describes asset storage and retrieval, plus the sources and workflows for documentation.db.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: davidschachteradfa, itsaky-adfa

Merge Risk: ⚪ Minimal · up to 8355b

The documentation changes are mergeable after normal checks; no concrete provenance error is established.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation changes about sibling repositories and documentation.db provenance.
Description check ✅ Passed The description explains the documentation changes and the asset and database provenance they cover.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A rabbit checks the asset trail,
From sibling repos to build-time stores,
The docs show where the sources dwell,
And how the database reaches builds,
Then hops away beneath the moon.

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