docs: consistency pass on README, docs and agent instructions - #7
Merged
Merged
Conversation
Gives the README the shared Cadasto layout (badges, what it is, where it fits, requirements, contents, then features, installation and the rest), opens every human-facing doc page with a paragraph naming its reader and purpose, removes em dashes and other AI-writing patterns, and corrects statements that no longer matched the tree. Agent-instruction files, components and released changelog sections are untouched. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Aligns the agent-instruction files with the shared Cadasto shape: .claude/CLAUDE.md imports AGENTS.md and keeps only Claude-specific notes; AGENTS.md follows Project Overview, Domain Context, Repository Layout, Components, Development, Gotchas, points to the docs/ page that owns each detail instead of restating it, carries no current version number, and drops em dashes. Commands, paths, CI triggers and hook descriptions are corrected against the tree; every still-true gotcha is kept. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
claude.ai/code answers the CI link checker with HTTP 403 from runner IPs, which failed the links job. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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.
Summary
A consistency pass shared by every Cadasto repo, in two commits:
.claude/CLAUDE.mdimportsAGENTS.mdand keeps only Claude-specific notes;AGENTS.mdfollows Project Overview, Domain Context, Repository Layout, Components, Development, Gotchas, points to thedocs/page that owns each detail, carries no current version number, and every command, path, CI trigger and hook description is checked against the tree. Every still-true gotcha is kept.Components, released changelog sections and code are untouched.
In this repo
docs/versioning.md: release step to update the README badge; the session-start banner already lists components.v0.5.0status;hooks-test.shcovers all three hooks; CI trigger; CHANGELOG subsystem examples match the history.scripts/validate.py,--selftest,scripts/hooks-test.sh.🤖 Generated with Claude Code