New Unified Documentation

[jack-champagne]

This pull request updates the documentation build system and enhances the documentation for the Piccolo package. The main changes include switching to a new documentation template package, improving the workflow for fetching documentation utilities, updating dependencies, and adding new and reorganized documentation files.

Documentation build system improvements:

• Updated .github/workflows/docs.yml to use the get_docs_utils.sh script for fetching the documentation template, and changed the template version to v0.2.0. The previous manual cloning of utils.jl from doc_template is replaced with a streamlined script.
• Rewrote docs/get_docs_utils.sh to accept a version argument, extract the version from the workflow file if not provided, and install the PiccoloDocsTemplate Julia package instead of manually copying files. [1] [2]

Dependency and configuration updates:

• Added DocumenterInterLinks, PiccoloDocsTemplate, PiccoloQuantumObjects, and QuantumCollocation to docs/Project.toml to support new documentation features and cross-linking.
• Modified docs/make.jl to use new dependencies, set up inter-package documentation links, and update the documentation generation workflow to use the new template and plugins.

Documentation content additions and reorganization:

• Added new literate documentation files: docs/literate/features.jl (comprehensive feature listing and examples) and docs/literate/other.jl (ideas for future documentation improvements). [1] [2]
• Added a quickstart section and links to the README.md to guide users to the new documentation pages.
• Added planning notes for the quickstart guide in docs/literate/quickstart.jl.

[gennadiryan]

@jack-champagne what went wrong in the last run? I made the same changes to docs.yml in QC and it appeared to build the docs just fine; I did wrap the name of the variable in brackets though (as in rev=\"${DOC_TEMPLATE_VERSION}\")

[jack-champagne]

@jack-champagne what went wrong in the last run? I made the same changes to docs.yml in QC and it appeared to build the docs just fine; I did wrap the name of the variable in brackets though (as in rev=\"${DOC_TEMPLATE_VERSION}\")

last run was solid - other than the cache being kinda skipped. This run puts the pkg add after the cache is checked

[jack-champagne]

Its looking like that even though there was a cache hit on this one - its still re-precompiling everything. Keeping an eye on it

[gennadiryan]

Got it; my take would be to try this locally and see if the recompile can be avoided there; if so it's likely a matter of properly configuring cache. I'll keep investigating along those lines once I've made some more progress configuring the runners; lmk your thoughts.

[jack-champagne]

Sent you a DM, looks like the last run is all good. Everything works great - updating all the PRs now

[gennadiryan]

Ah good glad to see that