docs: add Workspace spec.remotes[] and spec.files[] sub-fields to reference#512
Merged
docs: add Workspace spec.remotes[] and spec.files[] sub-fields to reference#512
Conversation
…erence The Workspace reference table in docs/reference.md was missing the spec.remotes[].name and spec.remotes[].url fields that are defined in the API types and used in the 06-fork-workflow example. Additionally, spec.files[] was listed as a single entry without documenting its sub-fields (path and content). Expand the table to include all sub-fields so users can discover these features from the reference docs alone. Fixes #511 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
github-actions
bot
added
needs-triage
needs-kind
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
This was referenced Mar 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
spec.remotes[].nameandspec.remotes[].urlrows to the Workspace reference table indocs/reference.mdspec.files[]intospec.files[].pathandspec.files[].contentsub-field rowsThese fields are defined in the API types (
api/v1alpha1/workspace_types.go) and used in the06-fork-workflowexample, but were missing from the reference documentation.Fixes #511
Test plan
🤖 Generated with Claude Code
Summary by cubic
Add missing spec.remotes and spec.files sub-fields to the Workspace reference so users can configure remotes and injected files correctly. Matches the API definitions and 06-fork-workflow usage; fixes #511.
Written for commit 1ce66be. Summary will update on new commits.