Skip to content

Better SEO for Orval #2056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EwenQuim opened this issue Apr 22, 2025 · 2 comments
Open

Better SEO for Orval #2056

EwenQuim opened this issue Apr 22, 2025 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@EwenQuim
Copy link
Contributor

My previous contributions to the Orval project : https://github.com/orval-labs/orval/pulls?q=is%3Apr+author%3AEwenQuim

Orval doesn't appear in the search that is looking for "OpenAPI to Typescript" tools

Image

We just need to change some titles in the readme in the docs.

From the README:

"Visit orval.dev for docs, guides, API and beer!"

⬆ This is interesting information but it is NOT an SEO-ready title. I suggest "# Generate Typescript clients from OpenAPI specification"

From the docs:

Generate client with appropriate type-signatures

This can definitely be improved. I suggest "Instantly generate TypeScript clients from your OpenAPI specification"

From the github description:

orval is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in yaml or json formats. 🍺

I suggest the clearer "orval generates type-safe JS clients (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in yaml or json formats. 🍺"

I know, I repeat a lot "typescript" instead of "type-safe" or "type-signature" but that's not what users are searching for.


What do you think about that? I'll be happy to create an MR if you agree with this. Don't hesitate to challenge the wordings I propose

@melloware
Copy link
Collaborator

sure thing PR is welcome.

@melloware melloware added the documentation Improvements or additions to documentation label Apr 22, 2025
@melloware
Copy link
Collaborator

@EwenQuim ???

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
Projects
None yet
Development

No branches or pull requests

2 participants