Module help_topics

Expand description

Help topic registry – re-exported from lattice-help::topics.

Moved from lattice-ui-tui in Phase 5.2 first wave.

Structs§

HelpTopic: One free-form help topic.
HelpTopicRegistry: Catalogue of every registered topic, keyed by name. Plugins and future LSP integrations register through register.
HelpTopicsGenerator: gen:help-topics. Returns one RawCandidate per registered help topic so :help <Tab> enumerates available topics. The payload is CandidateData::Plain – topic name alone is enough for the v1 popup; future polish can introduce a richer HelpTopic variant if summaries need to flow through the matcher / annotator pipeline.

builtin_topics: The built-in topic set, generated at build time by build.rs from every docs/user/**/*.md (recursively, skipping tutor/). Each doc’s --- YAML frontmatter supplies summary + related (see the build script); bodies are embedded as string literals so the binary stays self-contained — no runtime filesystem dependency. Adding a doc requires no change here: drop the .md into docs/user/ and it registers automatically. CR.1: returns the registry by value. The caller wraps it in a HelpTopicRegistryHandle via HelpTopicRegistry::into_handle — the builtin set is the initial contents of a runtime-writable registry now, not the whole of it.

HelpTopicRegistryHandle: The runtime-mutable handle, registered as a boot service under this exact alias (the ServiceRegistry Arc/TypeId convention).