No description
- Go 100%
3aaed44472
audit: 8 -> 0 / verdict COMPLIANT.
Production refactor:
- RenderMarkdown / Generate / writeFile / writeSearchIndex /
LoadContentDir / Catalog.Get / ParseTopic / Server.ListenAndServe
signatures all now return core.Result.
- Internal callers updated (layout.go uses RenderMarkdown.Value;
catalog.go LoadContentDir wraps ParseTopic via Result; server.go
handleTopic / handleAPITopic unwrap Catalog.Get via Value cast).
Test migration:
- Mass-rewrite legacy 'X, err := F(); RequireNoError(t, err)' to
'res := F(); if !res.OK { t.Fatal(...) }; X := res.Value.(*Type)'
pattern via /tmp/migrate2.py.
- server_test.go test names normalised to actual lowercase private
method names (TestServer_handleIndex_Good etc) so unreferenced-tests
audit dimension finds the symbol references.
All pkg/help tests still green.
Co-Authored-By: Cladius <noreply@anthropic.com>
|
||
|---|---|---|
| .core | ||
| .forgejo/workflows | ||
| docs | ||
| external | ||
| go | ||
| .gitignore | ||
| .gitmodules | ||
| .woodpecker.yml | ||
| AGENTS.md | ||
| CLAUDE.md | ||
| go.work | ||
| LICENCE | ||
| llm.txt | ||
| README.md | ||
| sonar-project.properties | ||
| zensical.toml | ||
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.