search

opulo-inc / docs

Documentation for the assembly, maintenance, and usage of Opulo designs.
Other
11 stars 16 forks source link

Remove old build #137

Closed derbyshire10 closed 10 months ago

derbyshire10 commented 1 year ago

Removes an old build of the docs in the MKdoc build folder (site) and then added the site folder to .gitignore to prevent builds from being pushed to the repository in the future.

Builds don't need to be stored, as on every push to the main branch the Actions workflow rebuilds before deploying to docs.opulo.io and when modifying the site offline MKdocs serve will rebuild the site. Both not using the site folder.

gabeseltzer commented 11 months ago

@sphawes is it correct we don't need the site folder? I had always assumed it was some weird requirement for CI or something 🤷

derbyshire10 commented 11 months ago

Hi @gabeseltzer, the folder above is not needed for the CI as it rebuilds the project and overrides it.

In CI you are using the command 'mkdocs gh-deploy' and from the documentation below this command will build the project and then deploy it to Github.

https://www.mkdocs.org/user-guide/deploying-your-docs/