meilisearch / meilisearch/documentation
API reference: migration to OpenAPI-generated broke URLs
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 174
- Forks
- 276
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 6
Description
The migration to OpenAPI-generated documentation changed the URLs of the API reference.
Unfortunately, we did not introduce redirects, which means that links in various places are now broken.
The following broken links affect user experience:
- Links in SDKs methods - these show up directly in the users' IDE 🥲
- Links in blog posts
(I assume internal links in the docs were updated)
The following broken links affect contributor experience:
- Links in the open issue that used the docs as a reference for implementation
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the old API reference URLs with the OpenAPI-generated URLs and identifying the affected links in SDK methods, blog posts, and open issues. Confirm how redirects are configured for the documentation site; done means those existing links resolve to the corresponding API reference pages without breaking contributor or user-facing references.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100