mirror of
https://github.com/4gray/iptvnator.git
synced 2026-10-08 17:06:15 -08:00
chore(docs): remove external wiki-export tooling and instructions (#1121)
The wiki export to an external Obsidian vault is unused. Remove the wiki:export/test:wiki-export npm scripts, the external-wiki-sync architecture doc, and the IPTVNATOR_WIKI_VAULT workflow instructions from CLAUDE.md and AGENTS.md. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
4grayandClaude Fable 5 authored and GitHub committed
1 parent
1c710d69ef
commit
3659de796c
4 files changed
+5
-120
No files matched your search
@@ -30,11 +30,8 @@ This file provides guidance to coding agents working in this repository.
|
||||
- Keep the root `CLAUDE.md` and this file up to date. They are living documents: whenever a change touches something they describe — monorepo structure (new/moved/renamed apps or libs), routes, database schema/tables, stores and their features, key components, commands, environment behavior, or coding conventions — update the affected sections as part of the same task, and keep the process sections mirrored between `AGENTS.md` and `CLAUDE.md` in sync.
|
||||
- When adding a new feature area, check whether the Architecture or Key Features sections of `CLAUDE.md` describe the surrounding area; if they do, reflect the addition there instead of leaving the description stale.
|
||||
- Do not let `CLAUDE.md` or `AGENTS.md` drift: a stale path or route in these files poisons the context of every future agent session. If you notice an outdated claim while working, fix it (or flag it in the final summary) even if it is unrelated to the current task.
|
||||
- Repo docs are canonical even when they were originally drafted by an LLM. External wiki pages are derivative or synthesis content unless explicitly promoted back into the repo.
|
||||
- The external wiki sync is one-way by default: repo docs -> external wiki `_repo-context/`.
|
||||
- If repo docs changed and `IPTVNATOR_WIKI_VAULT` is configured, run `pnpm wiki:export --mode changed` after the doc update.
|
||||
- The wiki exporter only owns `_repo-context/` in the external vault. It must never overwrite repo docs or maintained wiki pages outside that folder.
|
||||
- Final task summaries should state whether docs were updated, which doc changed, and whether wiki export ran, was skipped, or failed.
|
||||
- Repo docs are canonical even when they were originally drafted by an LLM.
|
||||
- Final task summaries should state whether docs were updated and which doc changed.
|
||||
|
||||
## Regression Prevention And Test Updates
|
||||
|
||||
|
||||
@@ -23,11 +23,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
||||
- Keep this file (`CLAUDE.md`) itself up to date. It is a living document: whenever a change touches something it describes — monorepo structure (new/moved/renamed apps or libs), routes, database schema/tables, stores and their features, key components, commands, environment behavior, or coding conventions — update the affected `CLAUDE.md` sections as part of the same task, and keep the mirrored process sections in `AGENTS.md` in sync.
|
||||
- When adding a new feature area, check whether the Architecture or Key Features sections of `CLAUDE.md` describe the surrounding area; if they do, reflect the addition there instead of leaving the description stale.
|
||||
- Do not let `CLAUDE.md` drift: a stale path or route in this file poisons the context of every future agent session. If you notice an outdated claim while working, fix it (or flag it in the final summary) even if it is unrelated to the current task.
|
||||
- Repo docs are canonical even when they were originally drafted by an LLM. External wiki pages are derivative or synthesis content unless explicitly promoted back into the repo.
|
||||
- The external wiki sync is one-way by default: repo docs -> external wiki `_repo-context/`.
|
||||
- If repo docs changed and `IPTVNATOR_WIKI_VAULT` is configured, run `pnpm wiki:export --mode changed` after the doc update.
|
||||
- The wiki exporter only owns `_repo-context/` in the external vault. It must never overwrite repo docs or maintained wiki pages outside that folder.
|
||||
- Final task summaries should state whether docs were updated, which doc changed, and whether wiki export ran, was skipped, or failed.
|
||||
- Repo docs are canonical even when they were originally drafted by an LLM.
|
||||
- Final task summaries should state whether docs were updated and which doc changed.
|
||||
|
||||
## Regression Prevention And Test Updates
|
||||
|
||||
@@ -213,16 +210,6 @@ are baselined in `tools/eslint/max-lines-baseline.mjs`; regenerate the baseline
|
||||
with `node tools/eslint/generate-max-lines-baseline.mjs` after splitting a file.
|
||||
Never add new files to the baseline.
|
||||
|
||||
### Documentation And Wiki Export
|
||||
|
||||
```bash
|
||||
# Export a full canonical-doc snapshot into the external Obsidian vault
|
||||
pnpm wiki:export --mode full
|
||||
|
||||
# Export only the latest repo context into the external Obsidian vault
|
||||
pnpm wiki:export --mode changed
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Monorepo Structure (Nx Workspace)
|
||||
|
||||
@@ -1,97 +0,0 @@
|
||||
# External Wiki Sync
|
||||
|
||||
Related:
|
||||
|
||||
- [Workspace Shell](./workspace-shell.md)
|
||||
- [SQLite DB Worker](./sqlite-db-worker.md)
|
||||
|
||||
## Summary
|
||||
|
||||
- Repo docs are canonical, even when they were originally drafted by an LLM.
|
||||
- The external Obsidian wiki imports canonical repo docs read-only into `_repo-context/`.
|
||||
- Higher-level synthesis pages stay outside `_repo-context/` in the wiki's own folders.
|
||||
- Sync is one-way by default: repo docs -> wiki context.
|
||||
|
||||
## Ownership Model
|
||||
|
||||
Canonical repo docs include:
|
||||
|
||||
1. `docs/architecture/**/*.md`
|
||||
2. top-level workflow docs such as `README.md`, `GETTING-STARTED.md`, `AGENTS.md`, and `CLAUDE.md`
|
||||
3. selected module `README.md` files when they describe current code behavior or workflows
|
||||
|
||||
The external wiki can add cross-links, feature pages, decision notes, and synthesis pages, but it must not become a second source of truth for the same implementation details.
|
||||
|
||||
## Export Scope
|
||||
|
||||
The repo-owned exporter writes only to `_repo-context/` inside the external vault.
|
||||
|
||||
Current default export scope:
|
||||
|
||||
1. `docs/architecture/**/*.md`
|
||||
2. `README.md`
|
||||
3. `GETTING-STARTED.md`
|
||||
4. `AGENTS.md`
|
||||
5. `CLAUDE.md`
|
||||
6. selected module `README.md` files
|
||||
|
||||
The exporter also generates:
|
||||
|
||||
1. `_repo-context/index.md`
|
||||
2. `_repo-context/repo-map.md`
|
||||
3. `_repo-context/recent-changes.md`
|
||||
4. `_repo-context/manifest.json`
|
||||
5. `_repo-context/state.json`
|
||||
|
||||
## Running The Exporter
|
||||
|
||||
Set the external vault path in the shell environment:
|
||||
|
||||
```bash
|
||||
export IPTVNATOR_WIKI_VAULT=/absolute/path/to/your/obsidian-vault
|
||||
```
|
||||
|
||||
Then run:
|
||||
|
||||
```bash
|
||||
pnpm wiki:export --mode full
|
||||
pnpm wiki:export --mode changed
|
||||
```
|
||||
|
||||
You can also override the vault path per command:
|
||||
|
||||
```bash
|
||||
pnpm wiki:export --mode changed --vault /absolute/path/to/your/obsidian-vault
|
||||
```
|
||||
|
||||
If the vault path is missing, the exporter skips cleanly and reports why it did not run.
|
||||
|
||||
## Agent Workflow After Changes
|
||||
|
||||
After a meaningful implementation change, agents must assess whether canonical repo docs need updates.
|
||||
|
||||
Documentation-worthy changes include:
|
||||
|
||||
1. new or changed user-visible behavior
|
||||
2. architecture or data-flow changes
|
||||
3. non-obvious maintenance workflows
|
||||
4. new setup, debugging, or operational steps
|
||||
5. new subsystem contracts or boundaries
|
||||
|
||||
Prefer updating an existing authoritative doc before creating a new one:
|
||||
|
||||
1. `README.md` for top-level developer or user workflows
|
||||
2. `docs/architecture/` for architecture, ownership, and behavior contracts
|
||||
3. the nearest module `README.md` for local usage or behavior
|
||||
|
||||
If docs changed and `IPTVNATOR_WIKI_VAULT` is configured, agents should run `pnpm wiki:export --mode changed` before considering the task complete.
|
||||
|
||||
## Promotion Workflow
|
||||
|
||||
If a wiki page becomes stable enough to be canonical:
|
||||
|
||||
1. promote that content back into a repo doc
|
||||
2. treat the repo doc as the source of truth
|
||||
3. export again so `_repo-context/` reflects the promoted canonical doc
|
||||
|
||||
The wiki page can then either link to the repo-backed generated page or remain as a smaller synthesis page that references the canonical doc.
|
||||
+1
-3
@@ -61,9 +61,7 @@
|
||||
"release:artwork:generate": "tsx tools/release/generate-marketing-artwork.ts --generate",
|
||||
"release:artwork:validate": "tsx tools/release/generate-marketing-artwork.ts --validate",
|
||||
"lint": "nx run-many --target=lint --all",
|
||||
"build": "nx build electron-backend",
|
||||
"wiki:export": "node tools/wiki/export-wiki-context.mjs",
|
||||
"test:wiki-export": "node --test tools/wiki/export-wiki-context.test.mjs"
|
||||
"build": "nx build electron-backend"
|
||||
},
|
||||
"private": true,
|
||||
"packageManager": "pnpm@10.33.0+sha512.10568bb4a6afb58c9eb3630da90cc9516417abebd3fabbe6739f0ae795728da1491e9db5a544c76ad8eb7570f5c4bb3d6c637b2cb41bfdcdb47fa823c8649319",
|
||||
|
||||
Reference in new issue
Block a user