docs: Add guide for using CLI to populate code samples without GitHub Actions#31
Conversation
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
🔗 Preview your changes |
|
@simplesagar is this good to go? |
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
|
I've updated the guide to clarify why promoting to the |
…d URL Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
|
I've updated the guide to include the specific instruction about clicking "Integrate with Docs Provider" to find the URL to the OpenAPI with code samples combined. This clarifies exactly where users need to click in the Speakeasy dashboard to access the public URL. |
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
|
I've updated the guide to include a new section explaining why users would choose CLI tagging instead of GitHub Actions. The section highlights several advantages including platform independence, custom workflow integration, local development capabilities, support for private repositories, and compatibility with enterprise environments that have specific security requirements. |
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
|
I've removed the entire 'Important notes' section as suggested, since the information was already covered elsewhere in the guide. This makes the document more concise and focused. |
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
|
I've removed the line referring to integration guides documentation as suggested, making the guide more concise. |
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
|
I've updated the links to documentation providers with the correct paths as suggested, using the full paths to the integration guides in the /docs/integrations/ directory. |
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
|
I've confirmed that the Scalar integration steps have been removed as suggested. I've also cleaned up the extra blank line between sections to maintain consistent formatting. |
|
I've confirmed that the trailing slashes have been removed from the Scalar and ReadMe documentation provider links as suggested. The links now correctly point to the integration guides without trailing slashes. |
Add guide for using CLI to populate code samples without GitHub Actions
This PR adds a guide explaining how to use the Speakeasy CLI to generate and publish code samples for API documentation when not using GitHub Actions. The guide covers:
The guide follows Speakeasy documentation style guidelines and is based on information from a Slack thread discussing this workflow.
Link to Devin run: https://app.devin.ai/sessions/15110ade33394f2d8e5ab242e6c52bfc
Requested by: sagar@speakeasyapi.dev