mirror of
https://github.com/Ar9av/obsidian-wiki.git
synced 2026-09-14 20:36:34 +08:00
ar9av
4bf87a8d19
Two strands of work. Session brain — a topic graph over raw agent session history, so you can find the session where something happened instead of remembering its UUID. Reads every Claude transcript plus the pruned sessions that survive only as prompts in history.jsonl, clusters them with local TF-IDF and community detection (no embeddings, no API calls, no new dependencies), and writes a sidecar at ~/.claude/session-brain/ — the vault is never touched. Ships five modules, the sessions-* CLI commands, an interactive graph.html, and the /session-brain and /wiki-sessions skills. This is retrieval, deliberately distinct from wiki-history-ingest, which distils sessions into permanent vault pages. Docs — README.md was 598 lines and put trust-check flags and a 17-row agent matrix in front of anyone evaluating the project. Cut it to a 129- line landing page (problem statement, 60-second install, four blocks of runnable commands, graph screenshot, why-not-a-notes-folder) and move the reference material into docs/: installation, agents, skills, cli, configuration, architecture, session-brain, contributing. README_TW.md mirrors the new structure; docs/ stays English-only for now. The restructure also closed real drift: - Ten skills existed but appeared in no reference — session-brain, session-search, wiki-dedup, wiki-digest, wiki-import, wiki-context-pack, wiki-stage-commit, wiki-switch, vault-skill-factory, and obsidian-layout-adjustment. - SETUP.md listed 12 of 39 skills and still claimed "no scripts, no dependencies" despite the pip package. It is now a signpost into docs/. - Eight config variables were undocumented anywhere, including WIKI_STAGED_WRITES, which wiki-setup prompts for and three skills read. Added to .env.example and docs/configuration.md. - sessions-name and a number of CLI flags were missing from the docs. Two details worth noting. README links are absolute GitHub URLs because pyproject sets readme = "README.md" as the PyPI long_description, and PyPI resolves relative hrefs against pypi.org rather than the repo — docs/ links would have 404'd on the package page. And three doc-drift guards asserted their facts against README.md; since those facts moved rather than disappeared, the assertions were repointed at the page that now owns each one instead of padding content back into the README. Also gitignore /vault/ (a local knowledge vault, not a fixture) and the packed browser extension. Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
87 lines
2.8 KiB
Python
87 lines
2.8 KiB
Python
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
import subprocess
|
|
import sys
|
|
import tempfile
|
|
import unittest
|
|
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
CHECKER = ROOT / "tools" / "check_readme_sync.py"
|
|
|
|
|
|
class ReadmeDriftTest(unittest.TestCase):
|
|
def setUp(self) -> None:
|
|
self._tmp = tempfile.TemporaryDirectory()
|
|
self.addCleanup(self._tmp.cleanup)
|
|
self.repo = Path(self._tmp.name)
|
|
self.git("init", "-q")
|
|
self.git("config", "user.email", "test@example.com")
|
|
self.git("config", "user.name", "Test")
|
|
|
|
def git(self, *args: str) -> None:
|
|
subprocess.run(["git", *args], cwd=self.repo, check=True, capture_output=True)
|
|
|
|
def commit(self, message: str, *files: str) -> None:
|
|
for name in files:
|
|
path = self.repo / name
|
|
path.write_text(path.read_text() + message + "\n" if path.exists() else message + "\n")
|
|
self.git("add", *files)
|
|
self.git("commit", "-q", "-m", message)
|
|
|
|
def run_checker(self) -> subprocess.CompletedProcess[str]:
|
|
return subprocess.run(
|
|
[sys.executable, str(CHECKER)],
|
|
cwd=self.repo,
|
|
text=True,
|
|
capture_output=True,
|
|
check=False,
|
|
)
|
|
|
|
def test_in_sync_passes(self) -> None:
|
|
self.commit("initial docs", "README.md", "README_TW.md")
|
|
|
|
result = self.run_checker()
|
|
|
|
self.assertEqual(result.returncode, 0)
|
|
self.assertIn("up to date", result.stdout)
|
|
|
|
def test_english_only_commits_are_reported_with_diff(self) -> None:
|
|
self.commit("initial docs", "README.md", "README_TW.md")
|
|
self.commit("add install section", "README.md")
|
|
|
|
result = self.run_checker()
|
|
|
|
self.assertEqual(result.returncode, 1)
|
|
self.assertIn("add install section", result.stdout)
|
|
self.assertIn("+add install section", result.stdout)
|
|
self.assertIn("backfill", result.stdout)
|
|
|
|
def test_later_translation_commit_clears_drift(self) -> None:
|
|
self.commit("initial docs", "README.md", "README_TW.md")
|
|
self.commit("add install section", "README.md")
|
|
self.commit("translate install section", "README_TW.md")
|
|
|
|
result = self.run_checker()
|
|
|
|
self.assertEqual(result.returncode, 0)
|
|
|
|
def test_unrelated_commits_do_not_trigger_drift(self) -> None:
|
|
self.commit("initial docs", "README.md", "README_TW.md")
|
|
self.commit("tweak cli", "cli.py")
|
|
|
|
result = self.run_checker()
|
|
|
|
self.assertEqual(result.returncode, 0)
|
|
|
|
def test_sync_workflow_is_documented(self) -> None:
|
|
for path in (ROOT / "AGENTS.md", ROOT / "docs" / "contributing.md"):
|
|
with self.subTest(path=path.name):
|
|
contents = path.read_text(encoding="utf-8")
|
|
self.assertIn("check_readme_sync.py", contents)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|