Skip to content

Commit c399769

Browse files
github-actions[bot]github-actions[bot]
committed
Update documentation
0 parents  commit c399769

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+4789
-0
lines changed

‎.nojekyll‎

Whitespace-only changes.

‎api/app.html‎

Lines changed: 52 additions & 0 deletions
Large diffs are not rendered by default.

‎api/index.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!doctype html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="refresh" content="0; url=./app.html"/>
6+
</head>
7+
</html>

‎api/search.js‎

Lines changed: 46 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎architecture.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Architecture: <project-name>
2+
3+
---
4+
5+
## YYYY-MM-DD — <feature-stem>: <short title>
6+
7+
Decision: <what was decided — one sentence>
8+
Reason: <why — one sentence>
9+
Alternatives considered: <what was rejected and why>
10+
Feature: <feature-stem>
11+
12+
---
13+
14+
## YYYY-MM-DD — Cross-feature: <short title>
15+
16+
Decision: <what was decided>
17+
Reason: <why>
18+
Alternatives considered: <what was rejected and why>
19+
Affected features: <feature-stem>, <feature-stem>

‎assets/banner.svg‎

Lines changed: 123 additions & 0 deletions
Loading

‎assets/logo.svg‎

Lines changed: 61 additions & 0 deletions
Loading

‎branding.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Branding — Python Project Template
2+
3+
> *From zero to hero — production-ready Python, without the ceremony.*
4+
5+
Agents read this file before generating release names, C4 diagrams, README banners, or any document with visual or copy identity. All fields are optional; absent or blank fields fall back to defaults (adjective-animal release names, Mermaid default colors, no wording constraints).
6+
7+
---
8+
9+
## Identity
10+
11+
- **Project name:** Python Project Template
12+
- **Tagline:** From zero to hero — production-ready Python, without the ceremony.
13+
- **Mission:** Eliminate boilerplate so engineers ship features, not setup.
14+
- **Vision:** The standard starting point for any serious Python project — the bedrock every Python engineer reaches for first.
15+
- **Tone of voice:** Direct, precise, minimal. The Greeks did not decorate the Parthenon with apologies. Neither do we.
16+
17+
## Visual
18+
19+
The palette is drawn from classical marble, parchment, and gold — materials that have carried ideas for millennia. Every colour choice serves legibility first; decoration is secondary.
20+
21+
- **Background/parchment:** `#faf7f2` → `#ede8e0` — warm off-white, the surface on which ideas are set down
22+
- **Primary text:** `#5c3d1e` → `#3b2410` — deep warm brown, the ink that endures
23+
- **Accent/gold:** `#c9a84c` → `#e8c96a` — antique gold, used for borders and structural lines only — never body text
24+
- **Secondary/blue:** `#7baabf` → `#4a7a96` — Aegean steel blue, for labels and secondary hierarchy
25+
- **Stone/marble:** `#f0ece4` → `#c8c0b8` — the load-bearing colour; columns, shapes, structural chrome
26+
- **Logo:** `docs/assets/logo.svg`
27+
- **Banner:** `docs/assets/banner.svg`
28+
29+
> Deep brown `#3b2410` on parchment `#faf7f2` achieves >10:1 contrast (WCAG AAA). Gold is decorative; it never carries meaning that must be read.
30+
31+
## Release Naming
32+
33+
- **Convention:** `adjective-greek-figure`
34+
- **Theme:** Greek antiquity — philosophers, heroes, gods, mythological figures. Every release name should read like an epithet: something a figure *earned* through their defining quality (e.g. "Resolute Athena", "Precise Pythagoras", "Luminous Hypatia").
35+
- **Rationale:** Ancient Greece is the origin of the intellectual tradition that underpins Western civilisation — democracy, systematic philosophy, formal logic, and scientific reasoning all trace their lineage to the Greek city-states. Plato and Aristotle invented political philosophy as a genre; Aristotle formalised logic and ethics; the Pythagoreans established that abstract reasoning could describe the physical world. This template stands on the same premise: rigorous method, applied from the beginning, produces something worth building on. The Greek figure in each release name is not decoration — it is a statement about what kind of work this is.
36+
- **Excluded words:** *(none)*
37+
38+
## Wording
39+
40+
Every word carries weight. The Greeks had a name for ornament that obscures meaning: *kenophonia* — empty noise.
41+
42+
- **Avoid:** `easy`, `simple`, `just`, `quick`, `scaffold` — these words undermine engineer credibility or imply the work is trivial. A temple is not a scaffold.
43+
- **Prefer:** `minimal`, `precise`, `production-ready`, `zero-boilerplate`, `rigorous`, `from zero to hero`
44+
45+
## Project Summary
46+
47+
A Python project template with a production-ready AI-assisted delivery workflow.
48+
Ships with quality tooling (ruff, pyright, pytest, hypothesis), Gherkin-driven
49+
acceptance criteria, and five specialised AI agents covering scope through release.
50+
Built on the premise that rigorous method, applied from the beginning, produces
51+
something worth building on. Use this summary in banners, release notes, and document headers.

‎c4/.gitkeep‎

Whitespace-only changes.

‎coverage/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Created by coverage.py
2+
*

0 commit comments

Comments
 (0)