Skip to content

docs: add aspid-wiki knowledge wiki (EN + RU vaults + skill) - #115

Draft
VPDPersonal wants to merge 4 commits into
Version/Aspid.MVVM-1.1.0from
docs/aspid-wiki
Draft

docs: add aspid-wiki knowledge wiki (EN + RU vaults + skill)#115
VPDPersonal wants to merge 4 commits into
Version/Aspid.MVVM-1.1.0from
docs/aspid-wiki

Conversation

@VPDPersonal

@VPDPersonal VPDPersonal commented May 31, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds aspid-wiki, a Claude Code skill (Ingest / Query / Lint / Export) that builds and maintains a navigable knowledge base of the framework. It uses a submodule-aware git-diff checkpoint for cheap incremental re-ingest (the source generators live in submodules, so the superproject diff alone misses their changes) and an English-source / translated-vault model.
  • docs/wiki/ — a 67-page English Obsidian vault generated from the codebase: overview, concepts, entities, flows, the source-generation pipeline, risks, reference, converters, and 33 binder categories. Pages are concise, link-checked, and carry source_paths back to code; filenames are human-readable and cross-linked with [[wikilinks]].
  • docs/wiki-ru/ — a full 1:1 Russian translation mirroring the English tree. English is the single source of truth; translations are regenerated from it (see the skill's references/translations.md). The model extends to further languages as docs/wiki-<lang>/.
  • Wire-up: .gitignore ignores per-user Obsidian working state for all docs/wiki* vaults (shared graph/appearance config stays tracked); CLAUDE.md points contributors at the wiki.

Why: re-establishing codebase context from raw source costs ~5–15k tokens per session before any work begins. Orienting from a few wiki pages instead of reading hundreds of .cs files cuts that cost for both agents and developers.

Notes for review

  • Draft / work-in-progress. Content was machine-generated from source (two Workflow fan-outs + a link-integrity lint pass) and is link-clean (zero broken [[wikilinks]]), but pages should be spot-checked for technical accuracy before this is marked ready.
  • Open the vault by pointing Obsidian at docs/wiki/ (or docs/wiki-ru/); docs/wiki/index.md is the hub.
  • The checkpoint in index.md (last_commit + submodule_commits) is set to this branch's base, so the next incremental Ingest only processes changes after it.
🇷🇺 Описание на русском

Summary

  • Добавлен aspid-wiki — скилл Claude Code (Ingest / Query / Lint / Export), который строит и поддерживает навигируемую базу знаний по фреймворку. Использует submodule-aware git-diff чекпоинт для дешёвого инкрементального ре-инжеста (source-генераторы живут в сабмодулях, и дифф суперпроекта их изменений не видит) и модель «английский — источник / переводные vault'ы».
  • docs/wiki/английский Obsidian-vault на 67 страниц, сгенерированный из кодовой базы: обзор, концепции, сущности, флоу, пайплайн source-генерации, риски, референс, конвертеры и 33 категории биндеров. Страницы компактны, ссылки проверены, каждая несёт source_paths к коду; имена файлов человекочитаемы и связаны [[wikilinks]].
  • docs/wiki-ru/полный 1:1 русский перевод, зеркалящий английское дерево. Единственный источник истины — английский; переводы регенерируются из него (см. references/translations.md скилла). Модель расширяется на другие языки как docs/wiki-<lang>/.
  • Обвязка: .gitignore игнорирует пер-пользовательское рабочее состояние Obsidian для всех vault'ов docs/wiki* (общий конфиг графа/внешнего вида остаётся под трекингом); CLAUDE.md направляет контрибьюторов в вики.

Зачем: восстановление контекста кодовой базы из сырых исходников стоит ~5–15k токенов на сессию ещё до начала работы. Ориентация по нескольким страницам вики вместо чтения сотен .cs-файлов срезает эту цену и агентам, и разработчикам.

Notes for review

  • Draft / work-in-progress. Контент сгенерирован машиной из исходников (два Workflow fan-out'а + линт целостности ссылок) и чист по ссылкам (ноль битых [[wikilinks]]), но перед переводом в ready страницы стоит выборочно проверить на техническую точность.
  • Vault открывается наведением Obsidian на docs/wiki/ (или docs/wiki-ru/); хаб — docs/wiki/index.md.
  • Чекпоинт в index.md (last_commit + submodule_commits) выставлен на базу этой ветки, так что следующий инкрементальный Ingest обработает только изменения после неё.

- New `aspid-wiki` skill (Ingest/Query/Lint/Export) with submodule-aware
  git-diff sync and an English-source / translated-vault model.
- `docs/wiki/` — 67-page Obsidian vault generated from the codebase
  (concepts, entities, flows, generation, risks, reference, converters,
  33 binder categories); human-readable filenames + `[[wikilinks]]`.
- `docs/wiki-ru/` — full Russian translation mirroring the English tree
  1:1; English remains the single source of truth.
- Wire-up: `.gitignore` ignores Obsidian working state; `CLAUDE.md`
  points contributors at the wiki.
- Generalize the ignore glob to docs/wiki*/.obsidian so docs/wiki-ru
  (and future translations) also skip per-user UI state.
- Untrack the docs/wiki-ru workspace.json that slipped into the prior commit.
@VPDPersonal VPDPersonal added type: documentation Documentation only status: work-in-progress Draft / not ready for review area: docs Documentation / knowledge wiki labels May 31, 2026
The catalog was written during scaffold before the per-category pages
existed, so only Text was linked. Now that all 33 category pages exist,
turn every category into a [[wikilink]] (EN + RU) and drop the stale
"pages still to create" note.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation / knowledge wiki status: work-in-progress Draft / not ready for review type: documentation Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant