Skip to content

Describe the test and docs workspace projects in CLAUDE.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1-Bort-1 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Describe the test and docs workspace projects in CLAUDE.md #16

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
87a8de1
Re-resolve the default manifests against Project.toml
1-Bort-1 Oct 6, 2026
28e02cd
CLAUDE.md: describe the docs and test workspace members
1-Bort-1 Oct 6, 2026
86a0350
Merge origin/main into agent/15-re-resolve-manifest-v1-13-toml-default-s
1-Bort-1 Oct 7, 2026
5cb259d
merge: latest main
1-Bort-1 Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,11 +155,12 @@ of the type the cached SciML specializations are keyed to.

## Environments

Root `Project.toml` declares `[workspace] projects = ["examples"]`, so `examples/` keeps
its own `Project.toml` (GLMakie, V3Kite and its solver chain — deliberately *not* deps of
the library) but resolves against the **single Manifest.toml at the root**. A dependency
shared by both is therefore the same version in a script as in the package it exercises.
Needs Pkg 1.11+; older Pkg silently resolves `examples/` standalone.
Root `Project.toml` declares `[workspace] projects = ["examples", "test", "docs"]`, so
`examples/` keeps its own `Project.toml` (GLMakie, V3Kite and its solver chain —
deliberately *not* deps of the library), as do `test/` and `docs/` (Documenter), but all
resolve against the **single Manifest.toml at the root**. A dependency the library shares is
therefore the same version in a script as in the package it exercises. Needs Pkg 1.11+;
older Pkg silently resolves `examples/` standalone.

Both `Project.toml` files carry comment blocks explaining *why* each compat bound and
`[sources]` pin exists (a `RuntimeGeneratedFunctions` exact pin that keeps the model cache
Expand Down Expand Up @@ -312,5 +313,4 @@ live REPL session picks up edits to `struct` definitions (`FC_Settings`,
- Remove or make inline comments 1 line where you see them.
- In YAML files, consider the comments at the top of the file as docstring where you can add multiline comments.
- Everything with a docstring should be added to the docs, otherwise you get an
error when building the docs. (This repository has no Documenter setup yet — no
`docs/make.jl`, no `docs/Project.toml` — so nothing enforces this today.)
error when building the docs (`include("docs/make.jl")`, `checkdocs = :exports`).
Loading