Skip to content

Commit a3eaa92

Browse files
committed
Add documentation guidance for version markers in CLAUDE.md
When adding new features to documentation, developers should use 'New in development version' markers. The deployment script automatically replaces these with actual version numbers during release.
1 parent 7994bbe commit a3eaa92

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CLAUDE.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,16 @@ just docs # Serve documentation locally at http://127.0.0.1:8080
6363

6464
Documentation is built with MkDocs and automatically deployed to GitHub Pages during `just deploy`.
6565

66+
**When adding new features to documentation**, mark them with version callouts:
67+
68+
```markdown
69+
**New in development version**
70+
71+
Description of the new feature...
72+
```
73+
74+
During release, the deployment script automatically replaces all "New in development version" markers with "New in version X.Y.Z" based on the release version. This ensures users know which version introduced each feature.
75+
6676
### Updating Country Data
6777

6878
Country data should be manually updated from the official ISO 3166-1 Online Browsing Platform (OBP):

0 commit comments

Comments
 (0)