Skip to content

docs: BRAND, DISTRIBUTION_SETUP, TROUBLESHOOTING, MIGRATION, ADR (#56)#115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ulises-jeremias merged 1 commit into from
Jul 16, 2026
Merged

docs: BRAND, DISTRIBUTION_SETUP, TROUBLESHOOTING, MIGRATION, ADR (#56) #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/BRAND.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# Brand

Working identity for CPA (to be refined):

- Tagline: One command. Any Python stack.
- Story: choose template → add addons → ship with uv
10 changes: 10 additions & 0 deletions docs/DISTRIBUTION_SETUP.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
# Distribution Setup

Secrets and publishers (see also #58–#63):

| Channel | Secret / config |
|---------|-----------------|
| PyPI | Trusted Publishing OIDC (no long-lived token) |
| Docker Hub | `DOCKERHUB_USERNAME`, `DOCKERHUB_TOKEN` |
| AUR | `AUR_SSH_PRIVATE_KEY`, `AUR_REPO_TOKEN` |
| Homebrew | `HOMEBREW_TAP_TOKEN` |
7 changes: 7 additions & 0 deletions docs/MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
# Migration

From hand-rolled Cookiecutter/Copier flows:

1. Map template repo to `templates.json` entry
2. Add `cpa.config.json`
3. Prefer `uv` lockfiles in generated projects
5 changes: 5 additions & 0 deletions docs/TROUBLESHOOTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
# Troubleshooting

- `uv sync` fails: check `.python-version` and network
- Non-empty target dir: pass `--force`
- Offline scaffold: ensure cache warmed or use `file://` fixtures
3 changes: 3 additions & 0 deletions docs/UIUX_BRANDING_HANDOFF.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# UI/UX branding handoff

Placeholder for website/marketing assets once the docs site exists.
9 changes: 9 additions & 0 deletions docs/adr/0001-uv-workspaces.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
# ADR 0001: uv virtual workspace monorepo

## Decision

Use a virtual uv workspace root (`packages/*`, single `uv.lock`) instead of Poetry/PDM.

## Consequences

Shared `.venv`, consistent dependency resolution, fast CI via `astral-sh/setup-uv`.
Loading