chore: starter template
This commit is contained in:
23
knowledge/design-language.md
Normal file
23
knowledge/design-language.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
type: Decision
|
||||
title: Design language
|
||||
description: UI/UX conventions decided for this app, applied consistently.
|
||||
tags: [design, ui]
|
||||
---
|
||||
# Design Language
|
||||
|
||||
High-level UI/UX decisions for this app. Use component inspection and the codebase for implementation details — record only things here that aren't obvious from reading the code, and only once a decision has been made and should be applied consistently.
|
||||
|
||||
<!-- e.g.
|
||||
- Drawers or modals? (which component, when each is used)
|
||||
- Toast notifications or inline feedback? (library, placement, which events trigger each)
|
||||
- Sidebar navigation: structure, depth levels, active state, how sections collapse
|
||||
- Loading states: skeletons, spinners, or shimmer? where each is used
|
||||
- Empty states: pattern and shared component if one exists
|
||||
- Confirmation pattern: modal, inline expand, or separate page?
|
||||
- Button hierarchy: primary / secondary / destructive variants
|
||||
- Typography: font families and when each is used, label conventions
|
||||
- Color token conventions: semantic names for status, surfaces, text
|
||||
- Form layout: label style, field spacing, error placement
|
||||
- Elevation / layering: how cards, panels, and overlays stack
|
||||
-->
|
||||
51
knowledge/index.md
Normal file
51
knowledge/index.md
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
type: Overview
|
||||
title: Knowledge base
|
||||
description: The builder agent's long-term memory, in the Open Knowledge Format (OKF).
|
||||
tags: [meta, okf]
|
||||
---
|
||||
# Knowledge base
|
||||
|
||||
This folder is the builder agent's long-term memory of **this company and product** — short
|
||||
markdown notes, not code. The agent reads these at the start of every session and updates
|
||||
them as it learns durable facts.
|
||||
|
||||
## Record ONLY what pikku can't tell you
|
||||
|
||||
Never duplicate anything the platform already gives you for free. Database tables and
|
||||
columns, function signatures, routes, wirings, permissions, and roles are all discoverable
|
||||
with `pikku meta` and the database tools — do **not** copy them here. They drift the moment
|
||||
the code changes, and a stale copy is worse than none.
|
||||
|
||||
Knowledge is the context introspection can't surface:
|
||||
|
||||
- **Domain concepts** — what the business's own terms mean
|
||||
- **Decisions and their reasons** — *why* an approach was chosen, trade-offs accepted
|
||||
- **Preferences** — style, scope, and things to avoid
|
||||
- **Constraints** — external facts (a partner API's quirk, a compliance rule) agreed with the user
|
||||
|
||||
## Format — Open Knowledge Format (OKF v0.1)
|
||||
|
||||
Each note is a markdown file whose **path is its identity**, with YAML frontmatter and a
|
||||
markdown body. Frontmatter fields (only `type` is required):
|
||||
|
||||
- `type` (required) — e.g. `Concept`, `Decision`, `Glossary`, `Preference`, `Overview`
|
||||
- `title` — a short human label
|
||||
- `description` — a one-line summary
|
||||
- `tags` — a list for grouping and search, e.g. `[security, billing]`
|
||||
- `resource` — a URL the note documents (a dashboard, doc, external service)
|
||||
- `timestamp` — ISO-8601 of the last meaningful change
|
||||
|
||||
Reserved filenames: `index.md` (this section overview) and `log.md` (a chronological
|
||||
history of changes). Cross-link notes with normal markdown links — they form a graph.
|
||||
|
||||
Suggested notes (create as needed):
|
||||
|
||||
- `product.md` — what the product is, who it's for, the core problem it solves
|
||||
- `glossary.md` — the company's own terms and what they mean
|
||||
- `decisions.md` — choices made together and why
|
||||
- `preferences.md` — style, scope, and things to avoid
|
||||
|
||||
Keep notes concise and current. Do not store secrets or credentials here.
|
||||
|
||||
Spec: https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf
|
||||
11
knowledge/security.md
Normal file
11
knowledge/security.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
type: Decision
|
||||
title: Security
|
||||
description: High-level, product-level security decisions for this app.
|
||||
tags: [security]
|
||||
---
|
||||
# Security
|
||||
|
||||
High-level security decisions for this app. Use `pikku meta functions` to discover the actual auth functions, permissions, and roles — record only context here that isn't in the code.
|
||||
|
||||
<!-- e.g. what auth approach was chosen and why, who can access what at a product level, any known security constraints or decisions made with the user -->
|
||||
11
knowledge/technology.md
Normal file
11
knowledge/technology.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
type: Decision
|
||||
title: Technology
|
||||
description: High-level technical decisions and context for this app.
|
||||
tags: [technology, architecture]
|
||||
---
|
||||
# Technology
|
||||
|
||||
High-level technical decisions and context for this app. Use `pikku meta` and the database tools for implementation details — record only things here that aren't obvious from introspection.
|
||||
|
||||
<!-- e.g. why a particular approach was chosen, third-party services integrated and why, known constraints or trade-offs, architectural decisions made with the user -->
|
||||
Reference in New Issue
Block a user