Skip to content
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

Serve multiple versions of API docs #452

Open
dessalines opened this issue Jan 22, 2025 · 2 comments
Open

Serve multiple versions of API docs #452

dessalines opened this issue Jan 22, 2025 · 2 comments

Comments

@dessalines
Copy link
Member

@Nothing4You mentioned this: we should try to serve up multiple versions of API docs. For now, I think

  • A next (which uses lemmy-js-client#main)
  • A latest (which uses the latest release tag)

These could then be served up at /api/next, and /api/latest

Context #451

@Nothing4You
Copy link
Contributor

If possible it would be nice to have each release kept, latest or stable could point to the latest release and then next from the main branch.
This is a common setup e.g. on readthedocs pages.
See for example https://docs.aiohttp.org/en/stable/, on the bottom right you can switch between a variety of versions:

Image

@dessalines
Copy link
Member Author

dessalines commented Jan 22, 2025

I'm not sure how they're doing that, but our docs are built from specific lemmy-js-client submodule declarations, so it probably wouldn't be a great idea to add a ton of these to the repo.

I've added just the two mentioned above.

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

No branches or pull requests

2 participants