Skip to content

Conversation

@alexvcasillas
Copy link
Owner

This pull request enhances the curl-runner documentation site by improving discoverability, navigation, and SEO, as well as adding new content and refining existing descriptions. Key changes include the addition of structured data for search engines, new sections highlighting configuration alternatives, an expanded "Next Steps" area, and the introduction of a "Tutorial Coming Soon" page. Several metadata descriptions have also been clarified for conciseness.

Content & Navigation Improvements

  • Added a new "Configuration Alternatives" section to the CLI Commands page, explaining how CLI options can be set via environment variables or global YAML configuration, with links to relevant docs.
  • Added an "Alternative Configuration Methods" section to the Global Settings page, showing users how to override settings via environment variables or CLI options, with direct links.
  • Expanded the "Next Steps" section on the main documentation page to four columns, added "Tutorials" and refined the "Use Cases" and "Examples" cards for better guidance and clarity. [1] [2] [3]
  • Added a new "Tutorial Coming Soon" page under /docs/tutorials/coming-soon, previewing upcoming content and providing alternative resource links for users.

SEO & Structured Data

  • Added structured data components (SoftwareDocumentationSchema, DocumentationArticleSchema, BreadcrumbSchema) to the main documentation and quick start pages to improve SEO and search engine visibility. [1] [2] [3] [4]

Metadata & Description Refinements

  • Improved and clarified metadata descriptions for CLI Options, Advanced Examples, Collection Examples, Output Formats, and Retry Mechanism documentation pages for better search relevance and conciseness. [1] [2] [3] [4] [5]

@alexvcasillas alexvcasillas self-assigned this Sep 19, 2025
@alexvcasillas alexvcasillas added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 19, 2025
@changeset-bot
Copy link

changeset-bot bot commented Sep 19, 2025

⚠️ No Changeset found

Latest commit: 27e9cfb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Sep 19, 2025

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

Project Deployment Preview Comments Updated (UTC)
curl-runner-docs Ready Ready Preview Comment Sep 19, 2025 4:19pm

@alexvcasillas alexvcasillas merged commit dfda14a into main Sep 19, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants