Honza/Dokumentace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Put the language in design document names and add a sync mode

Browse Source
This commit is contained in:
Jan Doubravský
2026-08-18 13:26:19 +02:00
parent 950e946004
commit 6737a27fa0
11 changed files with 306 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+26
View File
@@ -7,6 +7,32 @@ ships documents, so it uses the same `v#` scheme as the documents themselves.
Individual guideline documents carry their own `Document Version` header, and the skills carry
`metadata.version`; both are independent of the revisions below.
## v6 — 2026-08-18
### Added
- `--sync` in `check_versions.py` — offers to overwrite the outdated copies with the master, after
listing them and asking for confirmation (`--yes` skips the prompt, `--dry-run` writes nothing).
Each file keeps the line endings it already used, so a version bump stays a one-line diff on
Windows and Linux alike, and the write goes through a backup that is restored if it fails.
A `MODIFIED` copy is never overwritten — it holds a local edit that copying would discard
- `.gitignore` at the repository root for `__pycache__/`
### Changed
- **The design documents are renamed so the language is part of the file name**:
`DESIGN_DOCUMENT.md` → `DESIGN_DOCUMENT_PYTHON.md` / `DESIGN_DOCUMENT_RUST.md`,
`DESIGN_DOCUMENT_MODULE.md` → `DESIGN_DOCUMENT_PYTHON_MODULE.md`,
`DESIGN_DOCUMENT_LIB.md` → `DESIGN_DOCUMENT_RUST_LIB.md`. Python and Rust applications used to
share one file name, which only worked because the folder here disambiguated them — and the folder
does not travel with the copy that lands in a project root. A project can now carry one design
document per language, and `check_versions.py` no longer has to guess the language from
`Cargo.toml`. Bumped: `DESIGN_DOCUMENT_PYTHON.md` v10 → v11, `DESIGN_DOCUMENT_PYTHON_MODULE.md`
v3 → v4, `DESIGN_DOCUMENT_RUST.md` v3 → v4, `DESIGN_DOCUMENT_RUST_LIB.md` v3 → v4,
`AGENTS.md` v7 → v8, `CLAUDE.md` v2 → v3
- `check_versions.py` recognises the pre-rename file names, reports them as `OLD NAME`, and renames
them during `--sync`. The `Cargo.toml` check survives only to disambiguate legacy
`DESIGN_DOCUMENT.md` copies and can be deleted once every project is migrated. A project holding
both the old and the new name is reported as `DUPLICATE` and never touched
## v5 — 2026-08-18
### Added