Skip to content

Link to API and CLI docs in forms#3153

Draft
david-crespo wants to merge 1 commit intomainfrom
form-doc-links
Draft

Link to API and CLI docs in forms#3153
david-crespo wants to merge 1 commit intomainfrom
form-doc-links

Conversation

@david-crespo
Copy link
Collaborator

Fun and easy to do, but it needs a better visual treatment. Looked weird with API as a badge — it clashed with the external link icon. I'm always tempted to use the path instead of the operation ID, but the operation ID corresponds better to the method name in the SDK, SDK is probably more common than straight curl, and if they want the path they can get it from the docs.

image

@vercel
Copy link

vercel bot commented Mar 25, 2026

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

Project Deployment Actions Updated (UTC)
console Ready Ready Preview Mar 25, 2026 3:19am

Request Review

@david-crespo
Copy link
Collaborator Author

It might look better if we only linked the API instead of both, which we could do if the API doc linked to the CLI doc. I bet I could put something in the generated CLI schema that would let us match up commands to API endpoints.

@charliepark
Copy link
Contributor

I don't love this idea, but what about color-coding the icons based on the main theme colors at the docs?

Might make more sense if we had more colors besides green in console.

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.

2 participants