Skip to content

docs: inventory secondbrain external integrations - #89

Merged
levineam merged 1 commit into
mainfrom
SUP-3259/secondbrain-external-integrations
Jun 25, 2026
Merged

docs: inventory secondbrain external integrations#89
levineam merged 1 commit into
mainfrom
SUP-3259/secondbrain-external-integrations

Conversation

@levineam

@levineam levineam commented Jun 25, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add the canonical public inventory for external software/artifact layers in the jarvOS secondbrain stack.
  • Link the inventory from the public README and package READMEs with package-safe URLs.
  • Add a regression test for required components, authority boundaries, package README links, and package allowlist coverage.

Verification

  • node --test tests/secondbrain-external-integrations-doc-test.js
  • git diff --check
  • npm test
  • node scripts/release-readiness-check.js --allow-dirty --allow-existing-tag --skip-smoke
  • npm run release:drift
  • autoreview: clean, no accepted/actionable findings (/tmp/SUP-3259-autoreview/jarvOS/autoreview.md)

Documentation impact

  • Documentation impact: architecture-docs, module-docs, operator-docs.
  • Evidence: new docs/architecture/secondbrain-external-integrations.md; public README and module READMEs link it; package.json ships the linked doc; tests/secondbrain-external-integrations-doc-test.js guards the required claims.

Paperclip: SUP-3259

Summary by CodeRabbit

  • Documentation

    • Added a new architecture guide that inventories external integration points, status categories, boundaries, and supported operating paths.
    • Updated several README files to point readers to the new integration inventory and related guidance.
  • Tests

    • Added checks to keep the documentation consistent, including required integration entries, boundary statements, and correct linking from package and module docs.
    • Included the new architecture guide in the published package contents.

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Adds a new architecture inventory for secondbrain external integrations, links to it from the root and module READMEs, publishes the doc in package metadata, and adds Node tests that verify inventory content, links, and packaging coverage.

Changes

Secondbrain integration inventory

Layer / File(s) Summary
Inventory definitions
docs/architecture/secondbrain-external-integrations.md
Defines integration status terms and lists current external components with their roles and authority boundaries.
Operating model and boundaries
docs/architecture/secondbrain-external-integrations.md
Describes the capture-to-retrieval runtime path, proof surfaces, and explicit non-goals for the secondbrain stack.
README pointers
README.md, modules/jarvos-gbrain/README.md, modules/jarvos-secondbrain/README.md, modules/jarvos-skills/README.md
Adds links to the inventory from the root README and the module READMEs.
Package metadata and doc tests
package.json, tests/secondbrain-external-integrations-doc-test.js
Adds the inventory doc to the published file list, runs the new test in npm test, and verifies inventory content, authority claims, links, and package allowlist coverage.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • levineam/jarvOS#15: Updates README boundary guidance in the same secondbrain integration area.
  • levineam/jarvOS#17: Introduces @jarvos/gbrain, whose docs are referenced by the new inventory and module README links.

Poem

I hopped through docs with a carrot in paw,
and mapped each integration with rabbit-eye awe.
The vault, the wiki, the runtime all gleam,
in tidy little rows of a secondbrain dream.
🐰✨ Now every path has a moonlit clue.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding a documentation inventory of secondbrain external integrations.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch SUP-3259/secondbrain-external-integrations

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.

@levineam
levineam merged commit 4894a90 into main Jun 25, 2026
6 of 7 checks passed
@levineam
levineam deleted the SUP-3259/secondbrain-external-integrations branch June 25, 2026 19:35
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