Skip to content

docs: remove the workspaces contract (chat#1979) - #307

Merged
sweetmantech merged 2 commits into
mainfrom
chore/remove-workspaces-contract-1979
Aug 26, 2026
Merged

docs: remove the workspaces contract (chat#1979)#307
sweetmantech merged 2 commits into
mainfrom
chore/remove-workspaces-contract-1979

Conversation

@sweetmantech

@sweetmantechsweetmantech commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

Implements the docs item of recoupable/app#1979 (workspace account-type removal).

Merge order: this PR must merge BEFORE the api removal PR per the issue's resequenced order, so the docs stop advertising the endpoint before it starts returning 404.

Removals (net -114 LOC: +5 / -119)

  • api-reference/workspaces/create.mdx — deleted (the only page under api-reference/workspaces/)
  • api-reference/openapi/accounts.json — removed the POST /api/workspaces path and the CreateWorkspaceRequest / CreateWorkspaceResponse schemas. Both schemas were referenced only by the removed path (verified by grep across all OpenAPI specs); isWorkspace existed only inside CreateWorkspaceResponse
  • docs.json — dropped the now-empty "Workspaces" nav group
  • index.mdx — dropped "workspaces" from the accounts API card blurb
  • api-reference/openapi/social.json — dropped the workspace account type from four "(e.g., an artist, workspace, or organization)" parameter descriptions

Left untouched on purpose: sandbox/session workspace-repo references (sessions.json, research.json), filesystem workspace scaffolding in workflows/*.mdx, and the Slack workspace mention in content-agent.mdx.

Verification

  • python3 -c "import json; ..."accounts.json, social.json, and docs.json all parse
  • grep -rn "CreateWorkspace\|isWorkspace\|api/workspaces\|workspaces/create" — zero hits outside .git

🤖 Generated with Claude Code

https://claude.ai/code/session_01ExgW1WRbZXendHdFw1fwBT


Summary by cubic

Removes the workspace account-type API contract from the docs before the API removal, so the docs stop advertising POST /api/workspaces and won't point to a 404.

  • Deletes the endpoint and its CreateWorkspaceRequest/CreateWorkspaceResponse schemas from accounts.json, the Create Workspace page, the Workspaces nav group, and workspace references in social.json and index.mdx.
  • Intentionally leaves sandbox/session and filesystem workspace references and the Slack workspace mention untouched.
  • Merge this before the API removal PR so docs don't reference a missing endpoint.

Written for commit db3863f. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Removed the workspace creation API endpoint and related request, response, and validation documentation.
    • Removed the Create Workspace API reference page and its navigation entry.
    • Updated connector examples to reference artists and organizations instead of workspaces.
    • Updated the Accounts section description to refer to organizations.

Removes the workspace account-type API contract ahead of the api removal
so the docs never advertise a 404:
- Delete api-reference/workspaces/create.mdx (the only page in the group)
- Remove POST /api/workspaces plus the workspace-only CreateWorkspaceRequest
and CreateWorkspaceResponse schemas from accounts.json
- Drop the Workspaces nav group from docs.json
- Drop 'workspaces' from the index.mdx accounts card and the workspace
account-type examples in social.json descriptions
Sandbox/session workspace-repo and filesystem-workspace references are
intentionally untouched.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ExgW1WRbZXendHdFw1fwBT
@coderabbitai

coderabbitaiBot commented Aug 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9517eea5-e1f3-457c-aede-3f19f45a99f0

📥 Commits

Reviewing files that changed from the base of the PR and between cb930e7 and db3863f.

📒 Files selected for processing (1)
  • docs.json

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


📝 Walkthrough

Walkthrough

The documentation removes the workspace creation API and its schemas. It also removes the Workspaces navigation entry and replaces workspace account references with organization or artist references.

Changes

Workspace API documentation

Layer / File(s)Summary
Remove workspace creation API contract
api-reference/openapi/accounts.json
The POST /api/workspaces endpoint, request and response schemas, and related error responses were removed.
Align documentation references
api-reference/openapi/social.json, docs.json, index.mdx
Connector descriptions no longer list workspaces as account examples. The Accounts navigation no longer includes the Workspaces group. The Accounts description now refers to organizations.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk:⚪ Minimal · up to db386

This change removes obsolete workspace API documentation and references without introducing a concrete correctness or production risk; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers:arpitgupta1214, sidneyswift

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly summarizes the main change: removing the workspaces API contract from the documentation. It is concise and specific.
Docstring Coverage✅ PassedNo 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✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

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 files.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/remove-workspaces-contract-1979

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.

@cubic-dev-aicubic-dev-aiBot 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.

No issues found across 5 files

Re-trigger cubic

@sweetmantech

Copy link
Copy Markdown
CollaboratorAuthor

Local Mintlify walk on db3863f — 2026-08-26

Branch refreshed with main today (merge db3863f, 0 behind; picks up the music pages). npx mintlify@latest dev on the branch, checked with Chrome DevTools; prod docs.recoupable.dev (current main) as the before-column.

Done-whenBranch (local)Prod (before)
No workspaces page/api-reference/workspaces/create404, "Page Not Found" 404200, 79 "workspaces" occurrences in the HTML
No nav entryAccounts tab sidebar: Accounts → Billing → Organizations → Admin groups, 44 links, the string "workspace" absent from the sidebar and page navsidebar carries the Workspaces group (7 occurrences on the Create Account page)
No dangling openapi refsall 9 api-reference/openapi/*.json + docs.json parse; `` grep for the removed Workspace* schemas: 0; `/api/workspaces` path: 0
llms.txt0 workspace lines1
Sandbox / Slack "workspace" untouchedthe remaining mentions are content-agent.mdx (Slack workspace), sessions.json / research.json (session workspace) and the workflows/* scaffold folders, all the other meaning of the wordsame

Diff vs main unchanged by the refresh: 5 files, +5 / -119.

@sweetmantech
sweetmantech merged commit a4b8a0c into mainAug 26, 2026
3 checks passed
Sign up for freeto 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

@sweetmantech