Skip to content

docs: Add guide for using CLI to populate code samples without GitHub Actions#31

Merged
walker-tx merged 16 commits into
mainfrom
devin/1747256876-cli-code-samples-without-github-actions
May 29, 2025
Merged

docs: Add guide for using CLI to populate code samples without GitHub Actions#31
walker-tx merged 16 commits into
mainfrom
devin/1747256876-cli-code-samples-without-github-actions

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

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:

  • Configuring the workflow
  • Generating SDKs and code samples
  • Promoting code samples to main using the tag promote command
  • Accessing the public URL
  • Integrating with Scalar
  • Automating the process with custom CI pipelines

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

Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@chailandau chailandau requested a review from a team May 17, 2025 17:38
@simplesagar simplesagar changed the title Add guide for using CLI to populate code samples without GitHub Actions docs: Add guide for using CLI to populate code samples without GitHub Actions May 19, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 20, 2025

🔗 Preview your changes
https://speakeasycom-git-docs-preview-pr-31-speakeasyapi.vercel.app
(The preview may still be building. Check back at this link in a few minutes.)

@chailandau
Copy link
Copy Markdown
Contributor

@simplesagar is this good to go?

Comment thread docs/guides/code-samples-without-github-actions.md Outdated
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

I've updated the guide to clarify why promoting to the main tag is important by drawing a parallel to GitHub's main branch. The main tag in Speakeasy now has a clearer explanation that it represents production-ready code samples, similar to how the main branch in GitHub represents production-ready code.

Comment thread docs/guides/code-samples-without-github-actions.md Outdated
…d URL

Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
Comment thread docs/guides/code-samples-without-github-actions.md Outdated
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

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.

Comment thread docs/guides/code-samples-without-github-actions.md
devin-ai-integration Bot and others added 2 commits May 28, 2025 13:33
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
Comment thread docs/guides/code-samples-without-github-actions.md Outdated
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

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>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

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.

Comment thread docs/guides/code-samples-without-github-actions.md Outdated
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

I've removed the line referring to integration guides documentation as suggested, making the guide more concise.

Comment thread docs/guides/code-samples-without-github-actions.md Outdated
Co-Authored-By: sagar@speakeasyapi.dev <sagar@speakeasyapi.dev>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

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.

Comment thread docs/guides/code-samples-without-github-actions.md Outdated
walker-tx and others added 2 commits May 28, 2025 08:46
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

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.

Comment thread docs/guides/code-samples-without-github-actions.md Outdated
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

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.

@walker-tx walker-tx enabled auto-merge (squash) May 29, 2025 14:01
@walker-tx walker-tx merged commit 8235046 into main May 29, 2025
2 checks passed
@walker-tx walker-tx deleted the devin/1747256876-cli-code-samples-without-github-actions branch May 29, 2025 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants