Skip to content

Document team context and current API workflows - #72

Open
crweiner wants to merge 2 commits into
mainfrom
indent/chandler-oct14-docs
Open

crweiner wants to merge 2 commits into
mainfrom
indent/chandler-oct14-docs

Conversation

@crweiner

@crweiner crweiner commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

Changes

  • Remove the nonexistent CLI 0.3.0 output example. The Homebrew tap recipe is already correct on current main.
  • Explain that OpenAPI info.version identifies a contract snapshot, not the URL version or installed CLI version.
  • Add team-context setup, beta eligibility, memory and skill operations, and agent-context reads.
  • Add Design System API operations and revision/retry requirements.
  • Document source availability and repository-bound sharing consent.
  • Document domain research, contacts, checkout, registration, and renewal operations, with registrar write opt-in explicit.
  • Explain preview-comment defaults, per-Space overrides, and installation permission requirements.
  • Add built-output regression tests.

Verification

check, validate, build, audit, verify:generated, verify:public-safety, verify:prose, and verify:routes passed. test:docs: 31 passed.

Generated reference pages and changelogs are unchanged. Existing PR #54 owns the generated snapshot refresh. The authored guides link to the live OpenAPI for full request/response schemas. API 0.6.0 alone does not establish a CLI 0.6.0 release or release date, so no speculative release entry is added.

View in Indent View in Slack
Tag @indent to continue the conversation here.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

Summary by CodeRabbit

  • Documentation
    • Added guidance for team context and Design System setup, including available APIs, permissions, revisions, uploads, and storage behavior.
    • Documented GitHub pull request preview controls and source-sharing options.
    • Added domain search and registration guidance, including payment, pricing, renewal, and purchase limitations.
    • Clarified API contract versioning and the information shown by sf --version.
  • Tests
    • Added checks for key installation, feature, permission, and domain documentation.

@indent

indent Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Issues

All clear! No issues remaining. 🎉

2 issues already resolved
  • The new Design System API note says the dashboard upload limit is 25 MB, but the dashboard now accepts files up to 100 MB (monorepo #3830). Line 23 also still says 25 MB. State a single 100 MB limit. (fixed by commit 6392b7c)
    Found by Indent Review Agent
  • The team-context table lists memory delete and skill toggle as operations owners and admins can call, but both are dashboard-only. Any API key or agent grant, even an owner's, is refused with authorization_level_not_allowed. (fixed by commit 6392b7c)
    Found by Indent Review Agent

CI Checks

All required checks passed on 6392b7c. The optional Spacefast Builds check failed again because the team is out of credits, not because of this PR's code.

Failing Spacefast Builds
  • The check summary reads '403: team is blocked: credit_exhausted'. The Spacefast team's build credits are exhausted, so the preview build was refused. It is not caused by this PR and is not a required check.

Review agents

Select any unchecked box below to run or rerun that agent.

Passed (1)
  • Indent Review Agent · Both earlier findings are fixed; no new problems found.
Full results

Indent Review Agent

  • Summary: Both earlier findings are fixed; no new problems found.
  • Last ran on commit: 6392b7ca
  • Latest result
    {
      "summary": "Both earlier findings are fixed; no new problems found.",
      "findings": []
    }

@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 42ccfe43-975f-4f3a-af9c-95caca6f4136

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 295ed1be-dad3-4594-abfa-ab50a061a107
📥 Commits

Reviewing files that changed from the base of the PR and between 1d65f40 and b7ec10f.

📒 Files selected for processing: 8
  • content/(concepts)/design-system.mdx
  • content/(concepts)/meta.ts
  • content/(concepts)/team-context.mdx
  • content/(publish)/git.mdx
  • content/(serve)/domains.mdx
  • content/api/index.mdx
  • content/cli/index.mdx
  • scripts/docs-experience.test.mjs

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Documentation now covers team context and Design System APIs, Git publishing and source-sharing controls, and domain research and registration. API and CLI version guidance was revised, and documentation tests were added.

Changes: Product and API documentation updates

Layer / File(s) Summary
Team context and Design System guidance
content/(concepts)/team-context.mdx, content/(concepts)/meta.ts, content/(concepts)/design-system.mdx, scripts/docs-experience.test.mjs
Documents team-context setup and APIs, links the page in Concepts metadata, and adds Design System API details and requirements. Tests assert key setup and asset-upload guidance.
Git publishing and source sharing
content/(publish)/git.mdx, scripts/docs-experience.test.mjs
Documents pull request preview comments, GitHub permission requirements, and source-sharing controls. Tests cover Git permissions and availability guidance, as well as domain requirements.
Domain research and registration
content/(serve)/domains.mdx
Documents domain research and registration endpoints, opt-in requirements, purchase and checkout behavior, and renewal constraints.
API and CLI version guidance
content/api/index.mdx, content/cli/index.mdx, scripts/docs-experience.test.mjs
Clarifies API contract versioning and describes the information shown by sf --version. Tests assert these statements.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Other

Suggested reviewers: alexanderaidun-a8c

Merge Risk: ⚪ Minimal · up to b7ec1

The documentation and tests are mergeable after normal checks; neither proposed change is needed.

Pre-merge checks: Passed 4 · Failed 1

Failed 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%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (6 skipped: 6 … Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed 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 clearly identifies the main changes: documentation for team context and current API workflows. It is concise and specific.
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.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (6 skipped: 6 unsupported.)

✨ Finishing Touches: 💡 2
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Comment thread content/(concepts)/design-system.mdx Outdated
@spacefast
spacefast Bot had a problem deploying to preview/indent/chandler-oct14-docs October 14, 2026 21:56 Failure
@indent

indent Bot commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

Corrected the team-context guidance in 6392b7c: memory deletion and skill changes require an owner/admin dashboard session. API keys and agent grants are explicitly excluded, with authorization_level_not_allowed documented. All 31 docs tests and prose checks pass.

View session

This branch was successfully deployed

1 active deployment
preview/indent/chandler-oct14-docs — 6392b7ca Deployed Oct 15, 2026 by spacefast[bot]
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