Mirrors/photoprism
1
0
Fork 0
mirror of https://github.com/photoprism/photoprism.git synced 2026-07-17 16:49:04 +00:00
Code Issues Projects Releases Wiki Activity

Docs: Document heading style as Chicago-style title case

Browse source 
Signed-off-by: Michael Mayer <michael@photoprism.app>
This commit is contained in:
Michael Mayer 2026-04-18 09:41:11 +02:00
parent ac9c9cf27b
commit d529f7fe4a
2 changed files with 9 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.claude/rules/commit-and-docs-style.md
View file

@ -29,19 +29,21 @@ Descriptions MUST conclude with a checklist of **Acceptance Criteria**:
## Specifications & Documentation
- Document headings must use **Title Case** (APA/AP style) across Markdown files. Always spell the product name as `PhotoPrism`.
- Document headings use a **Chicago-style title case**, with additional code- and path-aware normalization rules (see below). Always spell the product name as `PhotoPrism`.
- When writing CLI examples or scripts, place option flags before positional arguments unless the command requires a different order.
- Use RFC 3339 UTC timestamps in request and response examples, and valid ID, UID and UUID examples in docs and tests.
- Technical specifications in the nested `specs/` subrepository may not be present in every clone or environment. Do not add `Makefile` targets in the main project that depend on `specs/` paths.
- Auto-generated configuration and command references live under `specs/generated/`. Agents MUST NOT read, analyze, or modify anything in this directory.
- Nested Git repositories may appear to be ignored; if so, change directories before staging or committing updates.
> **Title Case** rules (APA/AP implementation):
> **Title Case** rules (Chicago-style headline capitalization, with code- and path-aware normalization):
> - Capitalize the first word of a title/heading and the first word of a subtitle.
> - Capitalize the first word after a colon, an em dash, or end punctuation.
> - Capitalize the first word after a colon, a dash, or end punctuation.
> - Capitalize major words, including the second part of hyphenated major words.
> - Capitalize all words of four letters or more.
> - Lowercase only minor words of three letters or fewer (articles, short conjunctions, short prepositions), except when they are in one of the positions above.
> - Preserve known acronyms (for example, API, CLI, HTTP, JSON) and slash-separated acronym groups (for example, CSV/TSV) as uppercase.
> - Preserve inline code spans (`` `foo` ``), file paths (e.g. `docs/foo-bar.md`), and slash commands (e.g. `/grill-me`) verbatim; do not recase their contents.
> - In headings, prefer `&` where needed; do not use `And` or `Or` in titles.
> Refresh the `**Last Updated:**` date at the top of documents whenever you make changes to their contents, using the format `January 20, 2026` (without time); leave it as-is for simple formatting or whitespace-only edits.

6
AGENTS.md
View file

@ -56,7 +56,7 @@ Optional nested repositories such as `plus/`, `pro/`, `portal/`, and `specs/` ma
### Specifications & Documentation
- Markdown headings must use Title Case. Always spell the product name as `PhotoPrism`.
- Markdown headings use a Chicago-style title case, with additional code- and path-aware normalization rules (see *Title Case rules* below). Always spell the product name as `PhotoPrism`.
- Put option flags before positional arguments unless the command requires another order.
- Use RFC 3339 UTC timestamps and valid ID, UID, and UUID examples in docs and tests.
- The nested `specs/` repository may be absent. Do not add main-repo `Makefile` targets that depend on it; when present, you may run its tools manually.
@ -65,9 +65,11 @@ Optional nested repositories such as `plus/`, `pro/`, `portal/`, and `specs/` ma
- Refresh `**Last Updated:**` when you change document contents, but leave it unchanged for whitespace-only or formatting-only edits.
- Nested Git repositories may appear ignored; change into them before staging or committing updates.
Title Case rules:
Title Case rules (Chicago-style, with code- and path-aware normalization):
- Capitalize the first word, the first word after a colon, dash, or end punctuation, and all major words, including the second part of a hyphenated major word.
- Lowercase only articles, short conjunctions, and short prepositions of three letters or fewer when they are not in one of those positions.
- Preserve known acronyms (for example, API, CLI, HTTP, JSON) and slash-separated acronym groups (for example, CSV/TSV) as uppercase.
- Preserve inline code spans (`` `foo` ``), file paths (e.g. `docs/foo-bar.md`), and slash commands (e.g. `/grill-me`) verbatim; do not recase their contents.
- Prefer `&` where needed; do not use `And` or `Or` in titles.
## Safety & Data