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

Host documentation on GitHub Pages #5

Open
calebzulawski opened this issue Jan 5, 2023 · 3 comments
Open

Host documentation on GitHub Pages #5

calebzulawski opened this issue Jan 5, 2023 · 3 comments

Comments

@calebzulawski
Copy link
Collaborator

No description provided.

@afranchuk
Copy link
Collaborator

Does it support versioned docs, though? I feel like I looked that up and it didn't, but I could be wrong. It's also (IMO) a bit unsettling to version control generated content (which Pages implies) only because it should be write-once stuff, but to be fair that's not a big deal (and if they do support versioned docs using tags, then it's more appropriate).

@calebzulawski
Copy link
Collaborator Author

Pages can actually be uploaded via actions artifact now: https://github.com/actions/deploy-pages

Versioning would be nice, but the only versioned docs I've seen available is readthedocs. Beside the standard library docs, I don't think it's so necessary to version the other docs, like the manual. Even the standard library could be documented in the style of rust or python, with the docs containing the version each function was added.

@afranchuk
Copy link
Collaborator

Oh yeah I saw that but kind of forgot. Doesn't matter much either way. I was definitely thinking of versioning specifically for the standard library, as the other docs (and language) are moving toward stability.

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