Files
five/rag/INDEX.md
CharlesKWON cf370564f3 docs(rag): Five knowledge corpus for LLM agents
A retrieval-ready knowledge base so an LLM can read/write Five without
prior training: overview, syntax, full RTL catalog (from hbrtl/register.go),
web/worker idioms (from the solmade app), and a long-tail gotchas file.
Every doc has keyword/summary frontmatter; INDEX.md is the routing manifest.

Grounded by parallel source exploration; RTL names spot-checked against
register.go. The gotchas file is the compounding asset — append new traps.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-15 13:54:03 +09:00

2.1 KiB

Five RAG — retrieval manifest

Route a query to the right doc(s). Each row: file · when to retrieve · keywords.

File Retrieve when the task involves… Keywords
01-overview.md orienting on what Five is, runtimes, compile model, "where do I look" five, fivenode, overview, philosophy, token-density, harbour, xbase, compile, go, runtime, gengo intrinsic
02-syntax.md writing any Five code — declarations, control flow, literals, operators, blocks syntax, grammar, FUNCTION, PROCEDURE, LOCAL, STATIC, IF, FOR, FOR EACH, DO WHILE, DO CASE, BEGIN SEQUENCE, IIF, code block, array, hash, string literal, operators, := == $
03-rtl-catalog.md "what function does X" — string/array/hash/json/date/regex/charset/math/crypto builtins rtl, builtin, Len, SubStr, Left, Right, At, Upper, AllTrim, PadL, PadR, StrTran, Chr, Asc, Val, Str, hb_NToS, hb_CStr, AAdd, AScan, AEval, hb_HGetDef, hb_HHasKey, hb_jsonDecode, hb_jsonEncode, ValType, HB_ISHASH, regex, HB_GETCHARSET, date, hb_ATokens
04-idioms.md building an endpoint, DB access, async/queue work, calling the LLM, building/deploying idioms, http, endpoint, routing, AP_BODY, AP_GETPAIRS, AP_JSONRESPONSE, ctx_set, ctx_get, LABDB_GET_PG, PG_QUERY, PG_EXEC, PG_LAST_ERROR, RETURNING, CREATE TABLE IF NOT EXISTS, text_tasks, FOR UPDATE SKIP LOCKED, job queue, LLM_CHAT, fnode, build.sh, launchctl
05-gotchas.md debugging "why doesn't this work", or BEFORE editing string funcs / charset / SQL / LLM gotcha, trap, intrinsic, gengo, charset, utf8, string escape, Chr, pgrtl string columns, Val, hb_CStr, model local, ResolveLlmModel, two runtimes, fnode, analyzer warning, CWD module resolution

Quick routing heuristics

  • Writing new code → 02 + 04, and skim 05 first.
  • "Which builtin?" → 03.
  • Bug that defies the grammar → 05 (almost always the answer is here).
  • "Why is my hbrtl edit ignored?" → 05 §1 (inlined intrinsics).
  • Korean/multibyte length/char issues → 05 §2,§3 + 03 charset section.
  • Numbers read from DB are wrong → 05 §4.