Skip to content

docs: improve the new revision#215

Merged
miyoungc merged 4 commits intomainfrom
miyoungc/doc-edits
Mar 11, 2026
Merged

docs: improve the new revision#215
miyoungc merged 4 commits intomainfrom
miyoungc/doc-edits

Conversation

@miyoungc
Copy link
Collaborator

@miyoungc miyoungc commented Mar 10, 2026

Summary

Comprehensive documentation improvements across the OpenShell docs site, focusing on consistency, clarity, and structural refinements.

Content Changes

  • New page: Added reference/support-matrix.md with platform, software, runtime, kernel, and container image requirements.
  • Expanded release notes: Added a Highlights section to the 0.1.0 release notes listing the core deliverables.
  • Supported agents table: Added a "Supported Agents" section to sandboxes/index.md summarizing built-in and community agents with their default policy coverage.
  • CLI reference updates: Added gateway add <url> to the command tree and the gateway commands table. Added lead-in sentences before tables and code blocks.
  • Architecture diagram: Changed from {image} to {figure} directive with a clickable :target: link.
  • Common use cases: Converted the bullet list in about/overview.md to a table for scannability.
  • Frontmatter metadata: Added MyST metadata (title, description, keywords, tags) to reference/default-policy.md.

Structural Changes

  • Relocated quickstart: Moved docs/about/get-started.md to docs/get-started/quickstart.md and updated all cross-references.
  • Removed tutorials index: Deleted the tutorials/index.md landing page and linked directly to tutorials/github-sandbox from the site nav and index cards.
  • Added support-matrix to toctree: Registered the new page in index.md.
  • Quickstart tabs: OpenClaw now has its own tab. Added a Community Sandbox tab for --from base. Removed the Next Steps section.
  • Landing page animation: Added opencode and codex to the terminal animation cycle and adjusted timing for four agents.

Style and Tone

  • Replaced informal phrasing ("see", "Once", "e.g.") with formal equivalents ("refer to", "After", "such as", "for example") across all modified pages.
  • Expanded contractions ("isn't" → "is not", "don't" → "do not") in technical prose.
  • Added lead-in sentences before tables, code blocks, and lists for better readability.
  • Standardized all "Next Steps" sections to use a consistent "To do X, refer to Y." pattern, replacing the bold question format ("Want X? Do Y.") across all docs.
  • Rewrote the GitHub sandbox tutorial for a more formal, technical tone with section introductions and structured verification steps.
  • Fixed minor formatting issues (YAML indentation in policy examples, trailing whitespace, "k3s" → "K3s", DGX Spark SSID casing).

Files Changed

Area Files
About overview.md, architecture.md, release-notes.md
Get Started quickstart.md (renamed from about/get-started.md)
Tutorials github-sandbox.md, index.md (deleted)
Sandboxes index.md, create-and-manage.md, policies.md, providers.md, community-sandboxes.md
Inference index.md, configure.md
Reference cli.md, default-policy.md, policy-schema.md, support-matrix.md (new)
Root index.md

@miyoungc miyoungc added this to the gtc milestone Mar 10, 2026
@miyoungc miyoungc self-assigned this Mar 10, 2026
@miyoungc miyoungc added the area:docs Documentation and examples label Mar 10, 2026
@miyoungc miyoungc force-pushed the miyoungc/doc-edits branch from 2bdd8d7 to 898937f Compare March 10, 2026 23:15
@github-actions
Copy link

github-actions bot commented Mar 10, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-11 00:41 UTC

@miyoungc miyoungc merged commit 261f35d into main Mar 11, 2026
11 checks passed
@miyoungc miyoungc deleted the miyoungc/doc-edits branch March 11, 2026 00:40
drew pushed a commit that referenced this pull request Mar 11, 2026
* improve the new revision

* update the animated commands

* more improvements and unifying text

* more fixes
drew pushed a commit that referenced this pull request Mar 16, 2026
* improve the new revision

* update the animated commands

* more improvements and unifying text

* more fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation and examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant