docs: add TODO.md and FINDINGS.md for fleet delegation
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
ad5e70937b
commit
2c4afaef7a
2 changed files with 55 additions and 0 deletions
26
FINDINGS.md
Normal file
26
FINDINGS.md
Normal file
|
|
@ -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
|
||||
29
TODO.md
Normal file
29
TODO.md
Normal file
|
|
@ -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
|
||||
Loading…
Add table
Reference in a new issue