docs: add CLAUDE.md with working notes for this repo - #868
Merged
Conversation
Captures what was learned across PRs #853-#867 so the next session does not rediscover it: the four-tree layout and why relative links cannot cross trees, npm-not-yarn, the CI gates and why external links are deliberately not gating, the code-block conventions the linter enforces, and the traps that actually bit -- farmers/labs twin pages, GitHub not redirecting /issues/N after a repo rename, the link checker only crawling ~93 pages, and the two Docusaurus slug rules that make correct-looking links break. The broken wipe loop quoted as an example is tagged ```text on purpose: it is a deliberately broken illustration, and check_docs_commands.py fails the build on it otherwise -- which it did, on the first run.
mik-tf
requested review from
AhmedHanafy725,
ramezsaeed,
scottyeager and
xmonader
as code owners
July 28, 2026 21:35
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
1 participant
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.
Captures what was learned across #853–#867 so the next person (or agent) picking this repo up does not rediscover it the hard way.
Contents
farmers/tolabs/yarnis not installed andyarn.lockis gitignored whilepackage-lock.jsonis committed, so use npm rather than the Makefile's yarn targets. Also:labis a Forgejo toolkit and does not apply to this GitHub repocheck_docs_commands.pyenforces, and why shellcheck rather thanbash -n/issues/Nafter a rename, the link checker only crawling ~93 pages, and the two Docusaurus slug rules that make correct-looking links breakOne detail worth noting
The broken wipe loop quoted as an example is tagged ```text deliberately. On the first run,
check_docs_commands.pyfailed on this very file — it lints untagged blocks, and a deliberately-broken illustration looks exactly like a broken command. The script's own advice message pointed at the fix.CLAUDE.md sits at the repo root, outside every docs plugin
path, so it is not published to the site.