Paweł Domański
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# Conventions
|
|
|
|
Coding style, naming, and structural conventions for the Knowledge Base.
|
|
|
|
## Language Convention
|
|
|
|
- **Synthesis Layer Content**: Polish (Polski) is used for summaries, index listings, concepts, and log descriptions (matching the current Polish structure of `knowledge/`).
|
|
- **Configuration & Schemas**: English is used for `GEMINI.md`, core repository schemas, and code/script names.
|
|
|
|
## Formatting & Link Style
|
|
|
|
- **Knowledge BaseLinks**: Prefer double brackets `[[knowledge/path/to/page]]` or standard relative link `[[page]]` for connections in the synthesis layer (`knowledge/`).
|
|
- **YAML Frontmatter**: When requested or appropriate, include metadata (tags, dates, source counts) at the top of markdown files.
|
|
- **Kebab Case**: File names in `knowledge/concepts/` and `knowledge/entities/` must be kebab-case (e.g., `human-in-the-loop.md`, `sql-server.md`).
|
|
|
|
## Log Bookkeeping
|
|
|
|
- **Log Appends**: Always append new entries to the top of `knowledge/log.md` with format:
|
|
```markdown
|
|
## [YYYY-MM-DD] Ingest | Source Title
|
|
- Bulleted details of created or updated pages.
|
|
```
|
|
|
|
## Feynman Problems Alignment
|
|
|
|
- **Central Alignment**: Every newly ingested raw file must be tested against the 12 Feynman Problems documented in `knowledge/feynman_problems.md`. If the content addresses or helps answer any of those questions, update the respective section in `knowledge/feynman_problems.md` with a direct link and concise insight.
|
|
|