Document the knowledge repository and the agent setup - #74
Open
finsberg wants to merge 1 commit into
Open
Conversation
The design records, specs, reference papers and agent memory now live in dolfinx-adjoint-knowledge rather than here, which keeps this repository free of files most contributors do not need but leaves no trace of where they went. Put it in the contributor guidelines rather than the README: it is setup for people working on the project, not information someone installing the package needs, and it sits naturally beside the existing notes on what CI expects. Covers linking the knowledge repository in, what an agent then picks up automatically, where per-project agent memory lives, and where the skills come from. Two things that are easy to get wrong are called out: the linking step has to add the paths to .git/info/exclude, because that file is per-clone and unversioned so a fresh clone would offer the symlinks up for commit; and those patterns must not carry a trailing slash, which matches a directory and silently stops matching a symlink.
finsberg
force-pushed
the
docs/knowledge-repo
branch
from
August 27, 2026 08:00
09a287a to
9ca9693
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The design records, specs, reference papers and agent memory now live in
dolfinx-adjoint-knowledge
rather than in this repository, which keeps this one free of files most contributors do not
need — but left no trace of where they went. This says where, and how to pick them up.
In the contributor guidelines rather than the README: it is setup for people working on the
project, not something someone installing the package needs, and it sits beside the existing
notes on what CI expects.
It covers linking the knowledge repository in, what a coding agent then picks up automatically,
where per-project agent memory lives, and where the repository-scoped skills come from.
Two things that are easy to get wrong are called out explicitly, because both fail quietly:
.git/info/exclude. That file is per-clone and isnot itself versioned, so a fresh clone does not inherit the exclusions and would offer the
symlinks up for commit — the one thing the separation exists to prevent.
.scratch/matches a directory and stopsmatching once the path is a symlink, which is exactly what happened here when the files moved.
The knowledge repository is private, so the section says so and makes clear nothing here depends
on it: you can build, test and contribute without it.
Separate from #71 deliberately — that one is about checkpointing and this is unrelated
documentation.
Note on CI
Check formattingfails on this branch, and it is not from this change: this branch isdocumentation-only, cut from
main, andmainis currently red.ruffreports twoimport-sorting errors in
src/dolfinx_adjoint/blocks/interpolation.pyandsrc/dolfinx_adjoint/types/function.py, introduced with the nonmatching interpolation work.Both are already fixed on the branch for #71, so merging that turns
maingreen again.🤖 Generated with Claude Code