Issue 20: Improving the example script

[SamuelBrand1]

This pull request introduces several improvements to the documentation, and forecasting code in the NowcastAutoGP.jl project. The most significant changes include a new automated vignette generation workflow using Literate.jl, updates to documentation images and navigation, improvements to parallelism and progress reporting in forecasting functions, and minor API enhancements.

Documentation workflow and navigation:

• Added docs/make_vignettes.jl to automate the generation of markdown vignettes from Literate.jl scripts, and updated documentation navigation to reference the new vignette locations. [1] [2] [3] [4]
• Updated example images in README.md to use new paths reflecting the generated vignette outputs.

Dependency management:

• Added new documentation dependencies: AutoGP, Literate, Parameters, and ProgressMeter to docs/Project.toml.

Forecasting code improvements:

• Improved parallelization and progress reporting in forecast_with_nowcasts by using Threads.@spawn for concurrent scenario processing and a progress bar for user feedback. [1] [2]
• Simplified the forecast and _forecast functions by removing the verbose argument and related logging, and by streamlining the HMC forecast sampling logic. [1] [2]

API enhancements:

• Added GPModel as a re-exported constant for user convenience in NowcastAutoGP.jl.
• Added new assertions in forecast_with_nowcasts for better input validation.

[Copilot]

Pull request overview

This PR modernizes the “getting started” documentation pipeline (moving the tutorial to a Literate.jl-generated vignette) and updates core forecasting utilities to improve scenario batching, including parallel execution and progress reporting.

Changes:

• Replace the Quarto tutorial with a Literate.jl source (docs/vignettes/getting-started.jl) and commit the generated markdown under docs/src/vignettes/.
• Update documentation navigation/build config to point to the new vignette location and add required docs dependencies.
• Refactor forecasting to remove forecast(...; verbose=...), adjust HMC sampling logic, and parallelize forecast_with_nowcasts via Threads.@spawn + a progress bar.

Reviewed changes

Copilot reviewed 12 out of 21 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/forecasting.jl	Refactors forecast / _forecast and parallelizes forecast_with_nowcasts.
src/NowcastAutoGP.jl	Re-exports GPModel for convenience.
docs/vignettes/tutorial.qmd	Removes the Quarto-based tutorial source.
docs/vignettes/getting-started.jl	Adds the Literate.jl vignette source.
docs/src/vignettes/tutorial.md	Removes the previously committed generated tutorial markdown.
docs/src/vignettes/getting-started.md	Adds the generated markdown output from Literate.jl.
docs/src/index.md	Updates “Getting started” link to the new vignette path.
docs/make_vignettes.jl	Adds a script to generate vignette markdown/images from Literate sources.
docs/make.jl	Updates Documenter pages config to include the new vignette.
docs/Project.toml	Adds documentation dependencies (e.g., Literate, Parameters, ProgressMeter).
README.md	Updates image paths to the new generated vignette outputs.
Project.toml	Bumps Julia compat to 1.11.
.gitignore	Tracks vignette-generated PNGs under docs/src/vignettes/.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.08%. Comparing base (6da107c) to head (cc0e4a0).

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #63      +/-   ##
==========================================
+ Coverage   94.64%   95.08%   +0.43%     
==========================================
  Files           5        5              
  Lines         112      122      +10     
==========================================
+ Hits          106      116      +10     
  Misses          6        6              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.