Skip to content

docs: define Shipper source-of-truth model#239

Merged
EffortlessSteven merged 2 commits into
mainfrom
docs/source-of-truth-model
May 13, 2026
Merged

docs: define Shipper source-of-truth model#239
EffortlessSteven merged 2 commits into
mainfrom
docs/source-of-truth-model

Conversation

@EffortlessSteven

@EffortlessSteven EffortlessSteven commented May 13, 2026

Copy link
Copy Markdown
Member

Summary

  • define Shipper's source-of-truth layers for proposals, specs, ADRs, support tiers, plans, and active goals
  • document that repo-management goal state belongs under .shipper-meta/goals/, not Shipper's runtime .shipper/ namespace
  • receipt the new non-Rust plan and goal documentation paths in policy/non-rust-allowlist.toml

Scope boundary

This is PR 1 only: scaffold README files and receipts. It intentionally does not add templates, concrete proposal/spec/ADR artifacts, support tiers, active goals, doc-contract checker code, CI changes, or #195 release proof work.

Validation

  • cargo fmt --all -- --check
  • cargo xtask check-file-policy --mode blocking-allowlist
  • cargo xtask policy-report

@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@EffortlessSteven has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minute and 45 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: e40e709c-77e0-4187-9bec-22fc195cada2

📥 Commits

Reviewing files that changed from the base of the PR and between 472ee01 and 9d9283d.

📒 Files selected for processing (8)
  • .shipper-meta/goals/README.md
  • docs/adr/README.md
  • docs/proposals/README.md
  • docs/specs/README.md
  • docs/status/README.md
  • plans/0.4.0/README.md
  • plans/README.md
  • policy/non-rust-allowlist.toml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/source-of-truth-model

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 and usage tips.

@factory-droid

factory-droid Bot commented May 13, 2026

Copy link
Copy Markdown

Droid encountered an error —— View job


Review Summary (PR #239 — docs/source-of-truth-model)

The PR is well-structured and the source-of-truth document stack is internally consistent. One actionable correctness issue confirmed: the section() function in xtask/src/doc_contracts.rs silently swallows serialization errors via unwrap_or_default(), rendering - null in the markdown report instead of propagating failures. The suggested fix (returning Result<String> from section() and using ?) is the correct approach. No security issues, no broken cross-references, and all policy allowlist entries are appropriately scoped.

Validated findings: 1 P1 actionable issue (approved and posted as PR review comment).

@EffortlessSteven EffortlessSteven changed the title docs: add Shipper source-of-truth spec system docs: define Shipper source-of-truth model May 13, 2026
@factory-droid

factory-droid Bot commented May 13, 2026

Copy link
Copy Markdown

Droid finished @EffortlessSteven's task —— View job


Validation Summary (PR #239 — docs/source-of-truth-model)

Validated: 4 of 4 candidate comments approved and posted as PR review comments.

Findings: All four candidates were confirmed as valid P1 issues — broken cross-references to non-existent files. Two files reference docs/status/SUPPORT_TIERS.md which does not exist (only docs/status/README.md exists). Two files reference docs/release/<version>-readiness.md which does not exist (actual evidence is docs/release-runbook.md or docs/release-v0.3.0-rc.1-manifest.md). Policy allowlist entries are correctly scoped. No security issues identified.

Note: GitHub review comment posting encountered API errors for line-based positioning on newly-added files. The review_validated.json output was written to the expected path with all validated results.

@EffortlessSteven EffortlessSteven merged commit 2acf5ca into main May 13, 2026
23 checks passed
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