Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 38 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,48 @@ ForgePlan/
├── templates/ ← markdown templates for each artifact kind
├── website/ ← official website (Astro + Starlight)
├── marketplace/ ← plugin marketplace (plugins + skills)
├── design/ ← design assets (forgeplan-design-system/ — canonical DS; Pencil .pen files later)
├── scripts/ ← build + release + helper scripts
├── Formula/ ← Homebrew formula
└── .local/ ← gitignored — local notes, research, sessions
```

## Design system (single source of truth)

**`design/forgeplan-design-system/`** — the canonical, portable ForgePlan design system package. **Consult it whenever the task involves UI, styling, branding, colors, typography, components, web pages, slides, diagrams, README visuals, or any user-facing surface** — before writing any CSS/HTML/component code.

Package contents (self-contained, no build step, no external deps):

| File | Purpose |
|---|---|
| `DESIGN-SYSTEM.ru.md` / `.en.md` | Canonical documentation: palette, contrast table, typography, spacing, components, accessibility, print, per-surface rules |
| `tokens.css` | Drop-in CSS custom properties for dark + light themes (`data-theme` attribute) |
| `tokens.graph.css` | Optional module for graph/map/canvas surfaces (relation edges, canvas strokes, composed-map zones, dot-grid) — load after `tokens.css` |
| `tokens.json` | Machine-readable token contract with fact/proposal status per token |
| `components.html` | Self-contained bilingual component reference with theme switcher — open in browser |
| `cheatsheet.ru.html` / `.en.html` | A4 landscape quick references with print styles |

Key invariants (details in the docs above):

- **One accent:** `--forge-ember #FF6B35`. Legacy `--accent #FF5A1F` is deprecated — never use in new code.
- **Light-theme text accent:** `--forge-ember-text #C94400` (orange fails WCAG as text on light bg; ember stays for fills/borders/focus).
- **Radius 0 by default** (2px chips, 3px inline code, 50% avatars/dots only). No shadows — flatness via `1px solid var(--forge-line)`.
- **Fonts:** Space Grotesk (UI/text) + Geist Mono (code, IDs, R_eff numbers, metadata).
- **Layout:** `max-width 1280px`, `32px` gutter, sticky elements use `top: var(--header-h)` (88px full / 36px compact).
- **Reuse rule:** to apply the system elsewhere, copy the whole `design/forgeplan-design-system/` directory and link `tokens.css`; do not re-derive values from `website/` source (the blog theme diverges — it is documented tech debt).

`design/` is the home for **all** design assets:

- `forgeplan-design-system/` — the canonical package above, plus `brand-assets/` (logo SVGs, favicons, icons)
- `forgeplan-site.pen` — Pencil source file (site mockups + the design system as atomic-design components: Atoms → Molecules → Organisms → Layouts)
- `visual-guides/` — approved raster methodology guides (design-system foundation, quick start, 9 thematic 16:9 sheets)
- `command-map/` — command map by scenario (portrait + 16:9)
- `source-materials/` — source briefs for the guide set
- `MANIFEST.md` — exact file inventory
- `snapshots/<ts>/` — CANVAS pipeline DS snapshot exports (when the pipeline runs)

The design system follows **atomic design**: tokens → atoms → molecules → organisms → templates/layouts. Higher layers are composed from lower-layer components (refs, not copies).

## Language

- **Documentation & commit bodies:** Russian preferred (matches project conventions)
Expand Down Expand Up @@ -100,3 +137,4 @@ If a future contributor joins, this section will be updated to reflect multi-aut
- [`docs/methodology/FORGEPLAN-GUIDE.md`](docs/methodology/FORGEPLAN-GUIDE.md) — full methodology reference
- [`docs/operations/AGENT-ENFORCEMENT.md`](docs/operations/AGENT-ENFORCEMENT.md) — agent rules and guardrails
- [`website/README.md`](website/README.md) — website architecture notes
- [`design/forgeplan-design-system/README.md`](design/forgeplan-design-system/README.md) — canonical design system package (tokens, components, cheatsheets)
40 changes: 40 additions & 0 deletions design/MANIFEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Manifest

## Design system

| File | Purpose |
| --- | --- |
| `design-system/DESIGN-SYSTEM.ru.md` | Каноническая русская документация |
| `design-system/DESIGN-SYSTEM.en.md` | Canonical English documentation |
| `design-system/tokens.css` | CSS custom properties, dark and light themes |
| `design-system/tokens.json` | Machine-readable token contract |
| `design-system/components.html` | Self-contained bilingual component reference |
| `design-system/cheatsheet.ru.html` | Русская A4-шпаргалка с print CSS |
| `design-system/cheatsheet.en.html` | English A4 reference with print CSS |
| `design-system/brand-assets/*` | SVG, PNG and ICO assets from the current site source |

## Visual guides

| File | Topic | Pixels |
| --- | --- | ---: |
| `visual-guides/00-design-system-foundation.png` | Основа дизайн-системы | 1672×941 |
| `visual-guides/01-quick-start-portrait.png` | Quick Start | 864×1821 |
| `visual-guides/02-development-cycle-16x9.png` | Полный цикл разработки | 1672×941 |
| `visual-guides/03-depth-selection-16x9.png` | Выбор глубины | 1672×941 |
| `visual-guides/04-artifact-types-16x9.png` | 10 типов артефактов | 1672×941 |
| `visual-guides/05-create-and-work-16x9.png` | Создание и работа с записями | 1672×941 |
| `visual-guides/06-diagnostics-and-agents-16x9.png` | Диагностика и агенты | 1672×941 |
| `visual-guides/07-evidence-protocol-16x9.png` | Evidence Protocol | 1672×941 |
| `visual-guides/08-reliability-fgr-16x9.png` | Надёжность и F·G·R | 1672×941 |
| `visual-guides/09-lifecycle-16x9.png` | Жизненный цикл записи | 1672×941 |
| `visual-guides/10-daily-work-16x9.png` | Ежедневная работа | 1672×941 |

## Command map

| File | Composition | Pixels |
| --- | --- | ---: |
| `command-map/forgeplan-command-map-a4-portrait.png` | Вертикальная печатная композиция | 1024×1536 |
| `command-map/forgeplan-command-map-16x9.png` | Горизонтальная экранная композиция | 1672×941 |

Обе карты сгруппированы по семи сценариям: старт и маршрутизация; поиск и чтение; создание и изменение; проверка и рассуждение; Evidence и связи; жизненный цикл; диагностика и агенты.

39 changes: 39 additions & 0 deletions design/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# ForgePlan Complete Pack v1.0

Единый пакет дизайн-системы, визуальных гайдов и справочных карт ForgePlan.

## Состав

- `design-system/` — полная документация на русском и английском, CSS- и JSON-токены, self-contained HTML-компоненты, печатные справочники и бренд-ассеты.
- `visual-guides/` — принятые растровые схемы ForgePlan: основа дизайн-системы, Quick Start и девять тематических листов.
- `command-map/` — финальная карта команд по сценариям работы в двух самостоятельных композициях: portrait и 16:9.
- `source-materials/` — исходное содержательное задание для набора гайдов и шпаргалок.
- `MANIFEST.md` — точный перечень файлов и размеров изображений.

## Зафиксированный визуальный контракт

- Канонический ember: `#FF6B35`.
- Доступный ember для обычного текста на светлом фоне: `#C94400`.
- Тёмный холодный фон, тонкие серые линии, плоские поверхности.
- Прямые углы по умолчанию: `radius: 0`.
- Один горячий акцент; зелёный используется только для подтверждённого успеха.
- Моноширинные команды и идентификаторы.
- Без свечения, огненных градиентов, стекла, мягких теней и декоративных скруглений.
- Состояния и типы различаются не только цветом.

## Финальность отбора

В пакет включены только последние принятые версии изображений. Исключены промежуточные варианты:

- с выдуманной монограммой `FP`;
- со служебными бейджами `CHEAT SHEET`, `A4` или `16:9` внутри макета;
- алфавитная A–Z-карта, которую заменила группировка по рабочим сценариям;
- браузерные HTML-рендеры серии, от которых отказались в пользу растровой инфографики.

## Использование

- Для разработки интерфейса начать с `design-system/tokens.css`, `design-system/tokens.json` и `design-system/components.html`.
- Для инженерных правил и миграции открыть `design-system/DESIGN-SYSTEM.ru.md` или английскую версию.
- Для публикаций и презентаций использовать изображения из `visual-guides/` и `command-map/`.
- Для печати использовать portrait-карту команд либо HTML-шпаргалки с печатными стилями.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading