2ac1b10257
Cleared the 4 docs-gaps audit findings by adding the canonical doc skeleton required of every consumer repo: - AGENTS.md (concise agent-orientation, mirrors go-i18n shape) - README.md (public-facing intro with badges, quickstart for both Markdown corpus and Go library, layout map, links to architecture/development) - docs/architecture.md (frontmatter-tagged: meta/architecture order=2; data flow + key types table) - docs/development.md (frontmatter-tagged: meta/contributing order=3; setup, topic-add walkthrough, CI/CD, conventions) Verification: - audit.sh: 203 → 199 findings (-4 docs-gaps cleared) - GOWORK=off go build ./pkg/help/ clean (production-side) - Note: go test ./... was already broken on dev (pkg/help/ax7_test.go imports dappco.re/go without go.mod entry — that's an existing ax7-files audit issue, not introduced by this change) Refs tasks.lthn.sh/view.php?id=1316 — remaining 199 findings need: - core/go wrapper additions per #1329 (strings.Builder, SplitSeq, Index, etc.) for banned-imports - Public-API redesign for 8 err-shape-funcs (architectural, Cladius lane) - Gaming-pattern cleanup for ax7-* dims (codex/Cladius round-N work) - One replace-directive in go.mod (Cladius go-mod hygiene) Filed-by: hephaestus Co-authored-by: Hephaestus <hephaestus@lthn.ai>
1.9 KiB
1.9 KiB
core/docs
Documentation platform for the Core ecosystem (CLI, Go packages, PHP modules, MCP tools). Published at https://core.help.
Module: dappco.re/go/core/docs
Licence: EUPL-1.2
Language: Go 1.26 (library) + Python 3 (site build via zensical)
Components
docs/— Markdown source files (217+) with YAML frontmatter, organised by section (Go, PHP, TS, GUI, AI, Tools, Deploy, Publish).go/pkg/help/— Go library for help content management: parsing, search, HTTP serving, and static site generation.
Quickstart
Build the static site
pip install zensical
zensical build
# Output: site/
Use the Go help library
import help "dappco.re/go/core/docs/pkg/help"
cat, err := help.LoadContentDir("docs/")
if err != nil { panic(err) }
results := cat.Search("install")
for _, r := range results {
fmt.Println(r.Topic.ID, r.Score)
}
Run as an HTTP server
srv := help.NewServer(cat)
http.ListenAndServe(":8080", srv)
// GET /, /topics/{id}, /search?q=X
// GET /api/topics, /api/topics/{id}, /api/search?q=X
Layout
docs/ Markdown content (217+ files)
go/pkg/help/ Help library (parser, catalog, search, server, generate, render)
external/ Submodule deps
zensical.toml Site build config (Python)
.forgejo/workflows/ Forgejo CI (deploy.yml builds + pushes site/ to BunnyCDN)
See docs/architecture.md for the help-library data flow and docs/development.md for contributor setup.
Licence
EUPL-1.2 — see LICENCE.