Skip to content

Commit 2efff22

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

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

+4781
-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: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Branding
2+
3+
All fields are optional. Blank or absent fields fall back to defaults (adjective-animal release names, Mermaid default colors, no wording constraints). Agents read this file before generating release names, C4 diagrams, README banners, or any document with visual or copy identity.
4+
5+
---
6+
7+
## Identity
8+
9+
- **Project name:** Python Project Template
10+
- **Tagline:** Production-ready Python, from zero to workflow in minutes.
11+
- **Mission:** Eliminate boilerplate so engineers ship features, not setup.
12+
- **Vision:** The standard starting point for any serious Python project.
13+
- **Tone of voice:** Direct, precise, minimal. No fluff.
14+
15+
## Visual
16+
17+
- **Background/parchment:** `#faf7f2` → `#ede8e0` — warm off-white marble (primary surface)
18+
- **Primary text:** `#5c3d1e` → `#3b2410` — deep warm brown (body text, headings)
19+
- **Accent/gold:** `#c9a84c` → `#e8c96a` — antique gold (borders, highlights, lines)
20+
- **Secondary/blue:** `#7baabf` → `#4a7a96` — muted steel blue (labels, secondary text)
21+
- **Stone/marble:** `#f0ece4` → `#c8c0b8` — structural marble tone (temple columns, shapes)
22+
- **Logo:** `docs/assets/logo.svg`
23+
- **Banner:** `docs/assets/banner.svg`
24+
25+
> Color system derived from the SVG assets (classical Greek temple aesthetic — marble, parchment, antique gold). Deep brown `#3b2410` on parchment `#faf7f2` achieves > 10:1 contrast (WCAG AAA). Gold accent used for decorative lines and borders only, not body text.
26+
27+
## Release Naming
28+
29+
- **Convention:** `adjective-greek-figure`
30+
- **Theme:** Greek antiquity — philosophers, heroes, gods, mythological figures (e.g. "Nimble Socrates", "Resolute Athena", "Precise Pythagoras")
31+
- **Excluded words:** *(none)*
32+
33+
## Wording
34+
35+
- **Avoid:** `easy`, `simple`, `just`, `quick` — these undermine engineer credibility
36+
- **Prefer:** `minimal`, `precise`, `production-ready`, `zero-boilerplate`
37+
38+
## Project Summary
39+
40+
A Python project template with a production-ready AI-assisted delivery workflow.
41+
Ships with quality tooling (ruff, pyright, pytest, hypothesis), Gherkin-driven
42+
acceptance criteria, and four specialized AI agents covering scope through release.
43+
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)