search

supercollider / sc-docs

SuperCollider documentation for the web
https://docs.supercollider.online
GNU General Public License v3.0
2 stars 1 forks source link

[FR] Build `develop` docs #3

Open mtmccrea opened 5 months ago

mtmccrea commented 5 months ago

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 commented 5 months ago

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.

mtmccrea commented 5 months ago

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 commented 4 months ago

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

mtmccrea commented 4 months ago

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.