Skip to content

Fix text quality issues in key docs entry points#242

Open
szepeviktor wants to merge 6 commits into
warpdotdev:mainfrom
szepeviktor:fix-docs-text-quality-entry-points
Open

Fix text quality issues in key docs entry points#242
szepeviktor wants to merge 6 commits into
warpdotdev:mainfrom
szepeviktor:fix-docs-text-quality-entry-points

Conversation

@szepeviktor

@szepeviktor szepeviktor commented Jun 20, 2026

Copy link
Copy Markdown

Summary

  • fixed several clear typos and wording issues in published docs
  • renamed editting_diff.png to editing_diff.png and updated its reference
  • corrected changelog and command-corrections text issues
  • rewrote the refund-policy caution in plans-pricing-refunds.mdx so the requirements are grammatical and explicit
  • removed non-executable narrative lines from the oz agent run example in reference/cli/index.mdx
  • fixed the Generate link target in known-issues.mdx
  • corrected first-person/internal wording in troubleshooting examples from our to your
  • fixed heading hierarchy in sending-us-feedback.mdx
  • refactored cloud-agents/quickstart.mdx:
    • removed the embedded TODO comment
    • replaced the inline mini-guide in Next steps with links to dedicated docs
    • removed the duplicated What to explore next section

Follow-ups

@dannyneira Tools used: https://github.com/crate-ci/typos and RoboViktor 🤖

@cla-bot

cla-bot Bot commented Jun 20, 2026

Copy link
Copy Markdown

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @szepeviktor on file. In order for us to review and merge your code, each contributor must visit https://cla.warp.dev to read and agree to our CLA. Once you have done so, please comment @cla-bot check to trigger another check.

@vercel

vercel Bot commented Jun 20, 2026

Copy link
Copy Markdown

@szepeviktor is attempting to deploy a commit to the warpdotdev Team on Vercel.

A member of the Team first needs to authorize it.

@oz-for-oss

oz-for-oss Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

@szepeviktor

Every PR must be linked to a same-repo issue before Oz can review it.

Next step: open or find a same-repo issue describing this change, then link it to this PR by adding Closes #123 to the PR description (or using the "Development" sidebar on GitHub). A maintainer will mark the issue ready-to-implement when it is ready. Once it is marked, comment /oz-review to re-trigger review.

See the contribution guidelines for the full readiness model.

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@szepeviktor

Every PR must be linked to a same-repo issue before Oz can review it.

Next step: open or find a same-repo issue describing this change, then link it to this PR by adding Closes #123 to the PR description (or using the "Development" sidebar on GitHub). A maintainer will mark the issue ready-to-implement when it is ready. Once it is marked, comment /oz-review to re-trigger review.

See the contribution guidelines for the full readiness model.

Powered by Oz

@cla-bot

cla-bot Bot commented Jun 20, 2026

Copy link
Copy Markdown

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @szepeviktor on file. In order for us to review and merge your code, each contributor must visit https://cla.warp.dev to read and agree to our CLA. Once you have done so, please comment @cla-bot check to trigger another check.

@cla-bot

cla-bot Bot commented Jun 20, 2026

Copy link
Copy Markdown

The cla-bot has been summoned, and re-checked this pull request!

@szepeviktor szepeviktor force-pushed the fix-docs-text-quality-entry-points branch from d1569ba to 2b215b5 Compare June 20, 2026 18:05
@cla-bot

cla-bot Bot commented Jun 20, 2026

Copy link
Copy Markdown

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @szepeviktor on file. In order for us to review and merge your code, each contributor must visit https://cla.warp.dev to read and agree to our CLA. Once you have done so, please comment @cla-bot check to trigger another check.

@szepeviktor

Copy link
Copy Markdown
Author

@cla-bot check

@cla-bot cla-bot Bot added the cla-signed label Jun 20, 2026
@cla-bot

cla-bot Bot commented Jun 20, 2026

Copy link
Copy Markdown

The cla-bot has been summoned, and re-checked this pull request!

Comment thread src/content/docs/agent-platform/cloud-agents/quickstart.mdx Outdated
@hongyi-chen hongyi-chen requested a review from rachaelrenk June 30, 2026 18:44
@vercel

vercel Bot commented Jun 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 30, 2026 8:25pm

Request Review

Comment thread src/content/docs/changelog/2022.mdx
- quickstart: keep link-out Next steps but de-duplicate links, restore the schedule example and integrations plan-tier note, and reword the intro
- sending-us-feedback: capitalize Enterprise (proper plan name)
- plans-pricing-refunds: restore refund/credit requirement strength while keeping the grammar fix and how-to link

Co-Authored-By: Oz <oz-agent@warp.dev>
@rachaelrenk

rachaelrenk commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Thanks for these, @szepeviktor! A lot of this is solid cleanup. The typo fixes, file rename, Generate link now pointing to its own page, our → your corrections, and the heading-hierarchy fix are all clear wins. 🙏

@hongyi-chen — on the copy changes you flagged, here's where I landed. I pushed a few tweaks directly to the branch rather than block on them:

Cloud agents quickstart
Linking out from "Next steps" matches a TODO we'd left in that section, so I kept that direction, with three adjustments:

  • Reworded the intro to "try these next steps", which is the copy we want to stick with.
  • The refactor had ended up linking the same Scheduled Agents and Integrations quickstarts twice on the page, and pointed to two different skills pages. I de-duplicated so each lands once.
  • Restored the oz schedule create example and the note that integrations require a Build, Max, or Business plan. That useful context was otherwise a click away.

Refund policy (plans-pricing-refunds.mdx)
The original was genuinely awkward (faulty parallelism), so the grammar fix is fair and I kept it, along with the new "how to enable" link. I did restore the original requirement strength though as the rewrite had softened "we require … before we can provide refunds or credits" into a suggestion. cc @hongyi-chen 👀 do we need a pricing official to confirm this line?

Feedback doc
Kept the heading-level fix; just recapitalized "Enterprise" since it's one of our plan names.

One process note: this still needs a linked same-repo issue before it can merge (the bot flagged this up top). II'll open a quick issue describing the cleanup and link it, so we can get this moving.

Thanks again for the contribution!

Resolve quickstart.mdx conflict from the cloud-agents -> platform restructure (warpdotdev#262): keep the link-out Next steps (de-duplicated, with the schedule example and Build/Max/Business note) and adopt the new /platform/ link paths.

Co-Authored-By: Oz <oz-agent@warp.dev>

@rachaelrenk rachaelrenk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

branch is now clean!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants