Skip to content

Fix text-quality issues across key docs entry points #276

Description

@rachaelrenk

Problem

Several high-traffic docs pages have small text-quality issues that hurt readability (and search/AEO): typos, an inconsistently spelled image filename, a mistargeted link, first-person/internal wording, heading-hierarchy problems, and a Cloud Agents quickstart "Next steps" section that both duplicated links and inlined guidance that now has dedicated pages.

Scope

  • Typos in changelog/2021.mdx, changelog/2022.mdx, changelog/2023.mdx, changelog/2026.mdx, and terminal/entry/command-corrections.mdx.
  • Rename src/assets/agent-platform/editting_diff.png → editing_diff.png and update its reference in local-agents/code-diffs.mdx.
  • known-issues.mdx: point the Generate link to /agent-platform/local-agents/generate/, and change "our" → "your" in the dotfile-isolation steps.
  • sending-us-feedback.mdx: fix the heading hierarchy (top section should be ##), keeping "Enterprise" capitalized as a plan name.
  • reference/cli/index.mdx: remove the non-executable narrative lines from the oz agent run example.
  • plans-pricing-refunds.mdx: fix the refund-policy caution grammar and add a "how to enable" link, while keeping the requirement strength intact.
  • cloud-agents/quickstart.mdx: convert the "Next steps" inline mini-guides to links to dedicated guides (per the existing TODO in that section), de-duplicate the links, and preserve the oz schedule create example and the integrations plan-tier note.

Notes

  • The refund-policy wording is kept as a hard requirement pending billing/legal confirmation.

Addressed by #242 .

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    improve or update documentationIncorrect, outdated, missing, or unclear documentation contentpriority/lowTypos, minor formatting, nice-to-have improvementstriageNeeds human review — remove after triaging

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions