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

[FR] Build develop docs #3

Open
mtmccrea opened this issue May 19, 2024 · 4 comments
Open

[FR] Build develop docs #3

mtmccrea opened this issue May 19, 2024 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@mtmccrea
Copy link
Member

mtmccrea commented May 19, 2024

It's great having up-to-date docs, this will be a big help!

I'm wondering if there's a solution to also serve up the latest version of docs from the develop branch (under a separate URL)?

While this wouldn't be the primary docs to point users too, it could be useful to reference in the context of development discussions (on PRs and Issues) and communicating upcoming changes to users as it comes up in conversation on the forums.

@capital-G
Copy link
Collaborator

capital-G commented May 20, 2024

GitHub pages can only serve one domain, so we would need a second repository to serve the dev docs under a different domain.

I forked this repo @ https://github.com/capital-G/sc-docs-dev and deployed it to https://dev.docs.supercollider.online/

We could add this repository as well into the supercollider organization if there is agreement that this should be a thing.

I think this is a very nice idea, maybe we should also build it every day instead of just every week.

@capital-G capital-G self-assigned this May 20, 2024
@capital-G capital-G added the enhancement New feature or request label May 20, 2024
@mtmccrea
Copy link
Member Author

I forked this repo @ https://github.com/capital-G/sc-docs-dev and deployed it to https://dev.docs.supercollider.online/

Thanks! It's helpful to already have this up and running. I'll update the README to make a note of it.

I think it makes sense to add it to the SC org given there's relatively little overhead with the "main" docs already there, but let's see what others say. At the moment, I don't have a preference between daily and weekly builds.

Thanks!

@capital-G
Copy link
Collaborator

@mtmccrea should we transfer the dev-docs repo to the SC organization?

@mtmccrea
Copy link
Member Author

I would be in favor of that!

Do you see any disadvantage of having it build daily rather than weekly? Things have picked up pace lately (thanks to your efforts!) so in times like these it can be good to view/share changes from the website that are more current.

@capital-G capital-G moved this to Wait for consent / additional review in SuperCollider development Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Wait for consensus
Development

No branches or pull requests

2 participants