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

RFC: Embed API documentation into website #890

Open
taras opened this issue Feb 8, 2024 · 0 comments
Open

RFC: Embed API documentation into website #890

taras opened this issue Feb 8, 2024 · 0 comments
Labels

Comments

@taras
Copy link
Member

taras commented Feb 8, 2024

Motivation

Deno website is hosting our API docs. Although convenient, it might send the wrong message to those unfamiliar with Deno.

It would be nice to have API docs hosted on our website.

Approach

We could use the same mechanism we use for v2 docs to serve API docs for different versions. This requires having the generated HTML somewhere we can download it. We could run a workflow on any effection-v* tag that generates HTML using Deno CLI, commit it, and push it to the tag.

This would allow us to read the docs for each version from the tag's tarball.

@taras taras changed the title Embed API documentation into website RFC: Embed API documentation into website Feb 8, 2024
@taras taras assigned taras and unassigned taras Feb 8, 2024
@taras taras added the RFC label Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant