Skip to content

Commit 2055441

Browse files
docs: BRAND, DISTRIBUTION_SETUP, TROUBLESHOOTING, MIGRATION, ADR
Closes #56 Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 4b7d661 commit 2055441

6 files changed

Lines changed: 40 additions & 0 deletions

File tree

docs/BRAND.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Brand
2+
3+
Working identity for CPA (to be refined):
4+
5+
- Tagline: One command. Any Python stack.
6+
- Story: choose template → add addons → ship with uv

docs/DISTRIBUTION_SETUP.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Distribution Setup
2+
3+
Secrets and publishers (see also #58#63):
4+
5+
| Channel | Secret / config |
6+
|---------|-----------------|
7+
| PyPI | Trusted Publishing OIDC (no long-lived token) |
8+
| Docker Hub | `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN` |
9+
| AUR | `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN` |
10+
| Homebrew | `HOMEBREW_TAP_TOKEN` |

docs/MIGRATION.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Migration
2+
3+
From hand-rolled Cookiecutter/Copier flows:
4+
5+
1. Map template repo to `templates.json` entry
6+
2. Add `cpa.config.json`
7+
3. Prefer `uv` lockfiles in generated projects

docs/TROUBLESHOOTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Troubleshooting
2+
3+
- `uv sync` fails: check `.python-version` and network
4+
- Non-empty target dir: pass `--force`
5+
- Offline scaffold: ensure cache warmed or use `file://` fixtures

docs/UIUX_BRANDING_HANDOFF.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# UI/UX branding handoff
2+
3+
Placeholder for website/marketing assets once the docs site exists.

docs/adr/0001-uv-workspaces.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ADR 0001: uv virtual workspace monorepo
2+
3+
## Decision
4+
5+
Use a virtual uv workspace root (`packages/*`, single `uv.lock`) instead of Poetry/PDM.
6+
7+
## Consequences
8+
9+
Shared `.venv`, consistent dependency resolution, fast CI via `astral-sh/setup-uv`.

0 commit comments

Comments
 (0)