53 lines
3.7 KiB
Markdown
53 lines
3.7 KiB
Markdown
---
|
|
okf_version: "0.2"
|
|
---
|
|
|
|
# Start here
|
|
|
|
This bundle explains the Nuxt repository: how it is developed, checked,
|
|
released, and what was learned getting there. It is the "why" behind the
|
|
config files — the configs say what, these documents say why.
|
|
|
|
* [Open questions](open-questions.md) - What is still undecided for the Nuxt site.
|
|
* [Backend endpoints](backend-endpoints.md) - The smallest API the frontend needs from the Go gateway: health, chapters, knockdown, events.
|
|
* [Future updates](future-updates.md) - Pipeline improvement backlog with effort estimates, not yet decided.
|
|
* [Update log](log.md) - History of changes to this bundle.
|
|
|
|
# Decisions
|
|
|
|
## CI/CD and releases (2026-10-18)
|
|
|
|
* [PR pipeline layering](decisions/pr-pipeline-layering.md) - Three layers: pre-commit for cheap deterministic checks, Gitea Actions for thorough ones, AI review for judgment.
|
|
* [AI review setup](decisions/ai-review-setup.md) - Plan model, env-only auth against prompt injection, read-only agent, verdict line as the posting gate.
|
|
* [Vulnerability audit policy](decisions/vulnerability-audit-policy.md) - Blocking audit; reviewed ignore-list for unfixable advisories in pnpm-workspace.yaml.
|
|
* [Release engineering](decisions/release-engineering.md) - release-please in manifest mode; conventional commits enforced at commit time.
|
|
* [Snyk paused and secrets policy](decisions/snyk-paused-and-secrets-policy.md) - Quota-paused job kept in place; `write:issue` scope required on every workflow token.
|
|
* [Publishing images to the own registry](decisions/registry-publishing.md) - A release tag builds the image and pushes it to registry.noelsabia.dev, with `docker_host: automount` on the runner.
|
|
|
|
## Docker and development environment
|
|
|
|
* [Dev container shape](decisions/dev-container-shape.md) - The source is bind-mounted into a container that already holds the dependencies, and the dev server runs as the image's `node` user.
|
|
* [Build layer order](decisions/build-layer-order.md) - Why the manifests are copied before the source, and what invalidates what.
|
|
* [Build context filter](decisions/build-context-filter.md) - What `.dockerignore` may exclude, and the one thing it must never exclude.
|
|
* [Production image shape](decisions/production-image.md) - Multi-stage, digest-pinned, non-root runnable Node server - measured build and serve.
|
|
* [Repository and compose layout](decisions/repo-and-compose-layout.md) - The Dockerfiles live with the app; the stack is assembled in `Local_Development`.
|
|
* [Mockup layout](decisions/mockup-layout.md) - One `DESIGN.md` per screen, with the screenshot and the source embedded.
|
|
|
|
## UI and icons (2026-10-23)
|
|
|
|
* [Icons via Nuxt Icon](decisions/icons-via-nuxt-icon.md) - Icons come only from `@nuxt/icon` with a locally installed Material Symbols collection; inline SVG for SSR, scanned client bundle, and no icon webfont.
|
|
* [SEO stack and site metadata](decisions/seo-and-metadata.md) - `@nuxtjs/seo` with one metadata file, a `Person` identity, a committed 1200x630 OG card, and no dynamic OG renderer or skew protection.
|
|
|
|
# The one-paragraph history
|
|
|
|
The repository started as the Nuxt app shell. Docker development (dev
|
|
container, layer order, context filter) came first, then a single day of
|
|
CI/CD work built the PR pipeline layer by layer — lint, typecheck,
|
|
secret scan, dependency audit, Dockerfile lint, AI review — fixing one
|
|
real failure per layer as it appeared (wrong provider account, wrong
|
|
CLI major version, arm64-hostile vendor images, a silently-skipping
|
|
`hashFiles`, a prompt-injectable credential file), then wired releases
|
|
via release-please and locked the message format with pre-commit hooks.
|
|
The pipeline now fails loudly, posts only real reviews, and needs no
|
|
human faith to operate.
|