From 2c4afaef7a4cea5372fa34b1497c5db3ce96775f Mon Sep 17 00:00:00 2001 From: Virgil Date: Thu, 19 Feb 2026 21:36:09 +0000 Subject: [PATCH] docs: add TODO.md and FINDINGS.md for fleet delegation Co-Authored-By: Virgil --- FINDINGS.md | 26 ++++++++++++++++++++++++++ TODO.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 FINDINGS.md create mode 100644 TODO.md diff --git a/FINDINGS.md b/FINDINGS.md new file mode 100644 index 0000000..7b61a57 --- /dev/null +++ b/FINDINGS.md @@ -0,0 +1,26 @@ +# FINDINGS.md -- go-help + +## 2026-02-19: Split from core/go (Virgil) + +### Origin + +Extracted from `forge.lthn.ai/core/go` `pkg/help/` on 19 Feb 2026. + +### Architecture + +- `Topic` struct with title, body, tags, related topics +- `Section` groups topics under a heading +- `Frontmatter` for YAML metadata in topic files +- `Catalog` loads topics from YAML files on disk +- `Search` provides keyword search across topics with scoring: + - Title match: +10 + - Section match: +5 + - Partial/body match: +0.5 + +### Dependencies + +- Pure Go, only external dependency is `gopkg.in/yaml.v3` + +### Tests + +- 2 test files covering catalog loading and search behaviour diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..e6e5e75 --- /dev/null +++ b/TODO.md @@ -0,0 +1,29 @@ +# TODO.md -- go-help + +## Phase 1: Search Improvements + +- [ ] Add fuzzy matching (Levenshtein distance or similar) +- [ ] Add stemming support for English search terms +- [ ] Add phrase search (quoted multi-word queries) +- [ ] Improve scoring weights -- currently title +10, section +5, partial +0.5 + +## Phase 2: core.help Integration + +- [ ] Feed CLI docs into help catalog (parse `core` subcommand help text) +- [ ] Serve catalog via HTTP for the `core.help` domain +- [ ] Add Markdown rendering for topic bodies in HTTP responses +- [ ] Generate static site from catalog for BunnyCDN deployment + +## Phase 3: AI-Assisted Search + +- [ ] Embed help topics into go-rag collections for semantic search +- [ ] Add vector similarity fallback when keyword search returns no results +- [ ] Support natural language queries ("how do I push all repos?") + +--- + +## Workflow + +1. Virgil in core/go writes tasks here after research +2. This repo's dedicated session picks up tasks in phase order +3. Mark `[x]` when done, note commit hash