Writing documentation

Set up for editing and building documentation All based around Quarto Documentation in ./docs

• installed basic python and jupyter extensions necessary including those for jupyter
• installed quarto
• installed the VSCode extension

Workflow

cd docs
quarto preview

Don’t forget that changes to config (e.g. _quarto.yml may need you to rerun quarto render to ensure the whole site is correctly rebuilt)

When you push to either dev or main branches, then a GitHub Action (see .github/workflows/publish.yml) will be triggered that should publish the current documentation to https://hylode.github.io/HyUi/.