📦 Source: moggleif/sbsommar · README · Issues
This is the developer-facing documentation for a static-site project. Start with the README on GitHub for project context, then use the index below to dive into contribution rules, architecture, data contracts, design tokens, environments, releasing, and the full requirements traceability matrix.
| File | What it covers |
|---|---|
| 01-CONTRIBUTORS.md | Contribution guidelines, git workflow, setup, linting |
| 02-requirements/ | Requirements index — audience overview and a map to the topic files below |
| 02-requirements/pages-navigation.md | Site structure, page inventory, navigation, footer, hero CTAs |
| 02-requirements/schedule-and-detail.md | Schedule views, inline activity detail, per-event pages, RSS, iCal, Markdown rendering |
| 02-requirements/add-edit-forms.md | Add and edit forms, validation, submit flows, time-gating, drafts, delete |
| 02-requirements/event-data.md | Event data, locations, archive policy, naming, derived active camp, QA isolation |
| 02-requirements/build-deploy.md | CI pipelines, environments, zero-downtime deploy, release docs, footer version, docs site build |
| 02-requirements/caching-performance.md | Cache headers, content-hash cache-busting, image dimensions and lazy-loading |
| 02-requirements/platform-security.md | Reliability, accessibility, language, security hardening, analytics, PWA, admin token, rate limiting |
| 02-requirements/design-and-content.md | Hero redesign, link colors, modal styling, registration banner, locale overview, index design |
| 02-requirements/archive.md | Archived requirements (superseded; IDs preserved) |
| 03-architecture/ | Architecture index — overview and a map to the topic files below |
| 03-architecture/data-layer.md | Camp YAML, metadata registry, active-camp resolution, archive, footer, robots |
| 03-architecture/rendering.md | Page rendering logic, project structure, RSS feed, per-event pages |
| 03-architecture/forms-and-api.md | Session cookies, inline validation, deletion, submit flows, time-gating, draft cache |
| 03-architecture/ci-and-deploy.md | Event data CI pipeline, validators, Markdown converter, PHP API, asset cache-busting |
| 03-architecture/pages-and-content.md | Navigation, upcoming camps, hero, accordions, iCal, analytics, image dims, cache headers, feedback, registration banner |
| 03-architecture/platform-and-security.md | PWA, admin token, rate limiting, regex hygiene |
| 03-architecture/appendix.md | Decisions deliberately rejected; design philosophy |
| 04-OPERATIONS.md | Operational lifecycle, deployment, disaster recovery |
| 05-DATA_CONTRACT.md | YAML schema, required fields, validation rules, ID format |
| 06-EVENT_DATA_MODEL.md | Why event data is shaped the way it is — ownership, metadata, stability |
| 07-DESIGN.md | Color palette, typography scale, spacing tokens, component rules |
| 08-ENVIRONMENTS.md | Local / QA / Production environments, secrets schema, this docs site |
| 09-RELEASING.md | Step-by-step guide for deploying to production, rollback, release tagging |
| 99-traceability.md | Requirements traceability matrix — every requirement, its tests, and its implementation |
This documentation site is intentionally hidden from search engines:
it is served with a Disallow: / robots.txt and every rendered
page emits a <meta name="robots" content="noindex, nofollow"> tag.
Reach it through a direct link only.
To suggest a change, edit the relevant Markdown file in the repository and open a pull request — see 01-CONTRIBUTORS.md for the workflow.