lean4-htt/doc
Kim Morrison 97d427b32b
doc: document release notes process and add guard check (#12158)
This PR documents the release notes writing process in detail and adds a
guard check to `release_checklist.py` to ensure release notes are
created for `-rc1` releases before proceeding with downstream repository
updates.

- **doc/dev/release_checklist.md**: Expanded "Writing the release notes"
section with detailed steps for generating, reviewing, and formatting
release notes in Verso format
- **script/release_checklist.py**: Added
`check_release_notes_file_exists()` to verify the release notes file
exists in reference-manual repository
- **.claude/commands/release.md**: Added "Release Notes" section
explaining the process for creating release notes during `-rc1` releases

🤖 Prepared with Claude Code

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-26 07:16:01 +00:00
..
dev doc: document release notes process and add guard check (#12158) 2026-01-26 07:16:01 +00:00
examples feat: String.toList_map (#11021) 2025-11-01 13:54:39 +00:00
images doc: update quickstart guide for new display name (#5193) 2024-08-28 13:29:16 +00:00
latex doc: upstream the Lean4 pygments lexer (#3125) 2024-05-20 11:40:24 +00:00
make doc: fix broken "quickstart" and "supported editors" link (#8785) 2025-09-02 12:45:04 +00:00
std doc: grove: more String data (#11557) 2025-12-09 15:49:33 +00:00
.gitignore
BoolExpr.lean chore: Std -> Batteries renaming (#4108) 2024-05-08 05:04:25 +00:00
metaprogramming-arith.lean refactor: remove some unnecessary antiquotation kind annotations 2022-07-23 17:09:32 +02:00
perf.md
README.md chore: remove old documentation site (#7974) 2025-05-14 14:31:33 +00:00
style.md doc: write a guideline for tactic docstrings (#11406) 2026-01-06 04:40:20 +00:00
syntax_example.lean doc: fix example style 2022-04-22 16:26:16 +02:00

Developer Documentation and Examples

This directory contains documentation that describes how to work on Lean itself, as well as examples that are included in documentation that's hosted on the Lean website. The make directory contains information on building Lean, and the dev directory describes how to work on Lean.

The documentation section has links to documentation that describes how to use Lean itself.