Skip to content

Proofread all documentation and finish the shared-agents symlink migration#83

Open
alexander-yevsyukov wants to merge 11 commits into
masterfrom
proofread-and-all
Open

Proofread all documentation and finish the shared-agents symlink migration#83
alexander-yevsyukov wants to merge 11 commits into
masterfrom
proofread-and-all

Conversation

@alexander-yevsyukov

Copy link
Copy Markdown
Contributor

What changed

Two workstreams on this branch:

1. Shared-agents submodule migration (completes ./config/pull)

fcf00dd had updated the config submodule and registered .agents/shared in .gitmodules, but the migration aborted before creating the symlinks — a stale gitignored Lychee cache under .agents/skills/check-links/.cache/ tripped the data-loss guard in adopt-shared-agents. After clearing that cache and re-running ./config/pull, this branch:

  • adds the six symlinks — .agents/{skills,scripts,guidelines}, .claude/{commands,agents} — into the .agents/shared submodule;
  • moves project.md to docs/ with .agents/project.md as a back-symlink;
  • refreshes the distributed agent instructions (AGENTS.md, Junie, Copilot, Hugo-tuned Claude settings);
  • adds root init-submodules and the org-wide secret-scan workflow; merges the shared .gitignore and untracks .idea/misc.xml.

2. Full-repo proofread (/proofread all)

~150 English grammar/punctuation/spelling fixes across 24 project-owned files — Markdown docs, KDoc/Javadoc, and Protobuf/JS doc comments. Dominant classes: restrictive "which"→"that", missing articles, subject–verb agreement, "allows to"→"allows -ing", compound-modifier hyphens, comma splices, and real-word typos ("defied"→"defined", "verifiers"→"verifies", "constrains"→"constraints", "fine-graded"→"fine-grained"). No code tokens, string literals, or machine-read directives were touched.

Why

  • The symlink migration makes shared skills/guidelines resolve from the agents submodule instead of stale copied files.
  • The proofread is the standard post-config-pull prose sweep.

Reviewer notes

  • Per AGENTS.md, skip config-distributed files in review (AGENTS.md, CLAUDE.md, .junie/guidelines.md, .github/copilot-instructions.md, .idea/**, init-submodules, distributed workflows) — they are upstream-owned. The reviewable content is the docs/** prose, code-sample comments, and the symlink structure.
  • The proofread is deliberately prose-only. Seven factual/code bugs spotted during the sweep (a wrong Protobuf java_outer_classname, a misspelled Gradle keyword in a snippet, prefix/suffix and package-name mismatches against their own examples, a missing proto semicolon, a stale chmod path, a misquoted book subtitle) are out of scope and tracked in a separate follow-up.
  • Commits are grouped semantically for review.

🤖 Generated with Claude Code

alexander-yevsyukov and others added 11 commits July 23, 2026 20:33
Link `.agents/skills`, `.agents/scripts`, and `.agents/guidelines` into the
`.agents/shared` submodule, and link `.claude/commands` and `.claude/agents`.
Move `project.md` to `docs/`, leaving `.agents/project.md` as a symlink.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Refresh `AGENTS.md`, Junie guidelines, Copilot instructions, and the
Hugo-tuned Claude settings distributed by `config`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The root `init-submodules` script bootstraps config-managed submodules in
fresh worktrees. Add the org-wide `secret-scan` workflow and refresh
`check-links`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
`.idea/misc.xml` is now project-local and no longer tracked.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Fix missing articles, a restrictive "which", a comma splice, a sentence
fragment, a "you/your" typo, and an unhyphenated compound modifier in
`README.md`, `CONTRIBUTING.md`, `EMBEDDING.md`, `SPINE_RELEASE.md`, and
`_diagrams/README.md`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Fix a comma splice and two restrictive "which" clauses in
`.agents/memory/reference/cache-warm-window.md`.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Fix missing articles and a restrictive "which" in the Javadoc and proto
doc comments of the `docs/_code/samples` sources. Copyright headers of
the touched files are refreshed by the `update-copyright` hook.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Fix catalog errors across `docs/content`, the preview index, and the
architecture-diagram script: restrictive "which" clauses, missing and
wrong articles, subject-verb agreement, "allows to" complementation,
compound-modifier hyphens, comma splices and missing commas after
introductory clauses, double spaces, and real-word typos ("defied",
"verifiers", "out", "withing", "constrains", "fine-graded").

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

1 participant