improve: documentation on preprocessors, upgrade Rust version#7
improve: documentation on preprocessors, upgrade Rust version#7pleich merged 2 commits intocispa:mainfrom
Conversation
This commit - improves the documentation on the preprocessors - fixes the grant information in the about page - upgrades the CI and Dockerfile to the latest Rust version
There was a problem hiding this comment.
Pull request overview
This PR updates the project documentation (notably around preprocessors and the funding/grant information) and bumps the Rust version used by CI and the Docker build to 1.94.
Changes:
- Expanded documentation explaining what the various preprocessors do and when they help.
- Updated documentation pages to correct/adjust funding and add a cross-reference from the landing page.
- Upgraded CI workflows and the Docker build image to Rust 1.94.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/usage-cli/advanced-configuration.md | Adds more detailed explanations of preprocessors and how to configure them. |
| docs/landing-page.tex | Adds a pointer to more information about preprocessors. |
| docs/about.md | Updates the grant/funding information on the about page. |
| Dockerfile | Updates the Rust base image to 1.94-slim for builds. |
| crates/taco-model-checker/src/lib.rs | Improves doc comments for model checker results. |
| CHANGELOG.md | Records the documentation changes and Rust version upgrade. |
| .github/workflows/test.yml | Updates CI Rust toolchain version to 1.94.0. |
| .github/workflows/static.yml | Updates docs deployment workflow Rust toolchain version to 1.94.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Note that this may depend on the given specification, as it may specify that some of the initial locations should be empty. | ||
| You can find more information on the purpose of different preprocessors in \cref{specifying-preprocessors}. |
There was a problem hiding this comment.
Line 83 has trailing whitespace at the end of the sentence (after the period). Also, this new \cref{specifying-preprocessors} relies on a unique reference target, but specifying-preprocessors is currently defined twice in advanced-configuration.md, which can break/ambiguate the link during the MyST build.
| Note that this may depend on the given specification, as it may specify that some of the initial locations should be empty. | |
| You can find more information on the purpose of different preprocessors in \cref{specifying-preprocessors}. | |
| Note that this may depend on the given specification, as it may specify that some of the initial locations should be empty. | |
| You can find more information on the purpose of different preprocessors in the section on specifying preprocessors in the advanced configuration documentation. |
This commit