Skip to content

docs: align DocC, website, and validation with canonical workflow API#26

Merged
christopherkarani merged 1 commit into
mainfrom
codex/assess-terra-for-drones
May 21, 2026
Merged

docs: align DocC, website, and validation with canonical workflow API#26
christopherkarani merged 1 commit into
mainfrom
codex/assess-terra-for-drones

Conversation

@christopherkarani

Copy link
Copy Markdown
Owner

Summary

Aligns public-facing docs, validation scripts, and website copy with the current canonical Terra API surface.

Changes

  • DocC profiler docs — Updates 惄Profiling情 presets to match source code: 惄extended情 is now 惄[.memory, .thermal, .metal]情 and 惄all情 adds 惄.espresso情. Notes that 惄.power情 and 惄.ane情 are opt-in modules that must be imported and started directly.
  • FoundationModels availability — Adds platform-availability guard notes in both 惄Docs/integrations.md情 and DocC.
  • Validation scripts — Expands banned legacy patterns to include 惄Terra.trace(情, 惄Terra.agentic(情, 惄Terra.loop(情, 惄TraceHandle情, 惄.attr(情, 惄.provider(情, and 惄.includeContent(情. Adds 惄Sources/TerraAutoInstrument/Terra.docc情 and 惄website/src情 to scanned scopes.
  • Tests — Adds a compile-checked Swift mirror for the 惄website/src/app/page.tsx情 recipe snippet, and includes the website in documentation lint coverage.
  • Website — Fixes the SPM install command to 惄swift package add-dependency https://github.com/christopherkarani/Terra.git情 and rewrites the hero code example to use 惄Terra.workflow(...)情 instead of the legacy 惄Terra.trace(...)情.
  • PUBLIC-API-COVERAGE.md — Commits the source-backed public API coverage matrix as the canonical documentation baseline.

Verification

  • 惄swift build情 passes
  • 惄Scripts/validate-doc-snippets.py情 passes
  • 惄Scripts/validate_no_legacy_refs.sh情 passes

Pre-existing issue

惄DocumentationLintTests / Every published cookbook swift snippet has a compile-checked mirror情 is already failing on 惄main情 (README.md has 12 snippets, only 6 mirrored). This PR does not change that ratio.

- Update profiling presets in DocC to match source (.power/.ane opt-in)
- Add platform-availability notes for TerraTracedSession
- Expand legacy-ref validation to cover .attr, .provider, Terra.trace, etc.
- Add website/src to doc-snippet scanning
- Mirror website page.tsx recipe in compile-checked snippet tests
- Fix website install command and hero example to use Terra.workflow
- Include PUBLIC-API-COVERAGE.md as source-backed public baseline

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d828e007cb

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread website/src/app/page.tsx
<div className="flex items-center gap-3 px-6 py-4 rounded-xl bg-white/5 border border-white/10 mono text-sm group cursor-pointer hover:bg-white/10 transition-all">
<span className="text-gray-500">$</span>
<span className="text-cyan-400 font-medium">swift package</span> add terra
<span className="text-cyan-400 font-medium">swift package</span> add-dependency https://github.com/christopherkarani/Terra.git

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Add a version selector to swift package add-dependency

The new install command shown on the landing page is not executable as written: swift package add-dependency requires a version selector (--from, --exact, --branch, --revision, or --up-to-next-minor-from). I verified this locally with swift package add-dependency --help and by running the exact command in a fresh package, which fails with error: must specify one of --exact, --branch, --revision, --from, or --up-to-next-minor-from. As a result, copy/pasting this onboarding command will fail for all users.

Useful? React with 👍 / 👎.

@christopherkarani christopherkarani merged commit 87efd85 into main May 21, 2026
0 of 5 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