feature-docs/org.meshtastic.feature.docs.model

Package-level declarations

Types

AI assistant result model.

data class AIDocAssistantSessionState(val messages: List<ChirpyMessage> = emptyList(), val isLoading: Boolean = false, val draftQuestion: String = "")

Chirpy assistant session state.

ChirpyMessage

@Serializable

data class ChirpyMessage(val id: String, val role: ChirpyRole, val text: String, val sources: List<SourceRef> = emptyList())

A single message in the Chirpy conversation.

ChirpyRole

@Serializable

enum ChirpyRole : Enum<ChirpyRole>

Message author role.

DocBundle

data class DocBundle(val pages: List<DocPage>, val pageIndex: Map<String, DocPage>, val bundleVersion: String, val generatedAt: String, val totalBytes: Long)

Runtime aggregate of the full documentation corpus.

DocPage

@Serializable

data class DocPage(val id: String, val title: String, val section: DocSection, val navOrder: Int, val resourcePath: String, val keywords: List<String>, val aliases: List<String> = emptyList(), val charCount: Int, val iconId: String? = null)

A single documentation page.

DocPageContent

data class DocPageContent(val page: DocPage, val html: String? = null, val markdown: String? = null, val cssPath: String? = null)

Content wrapper that decouples metadata from rendered content.

DocsAiError

sealed interface DocsAiError

AI error categories.

DocSearchQuery

data class DocSearchQuery(val rawText: String, val normalizedTerms: List<String>)

Normalized user search query.

DocSearchResult

data class DocSearchResult(val page: DocPage, val score: Int, val matchedTerms: List<String>)

Ranked search result.

DocSection

@Serializable

sealed interface DocSection

Top-level documentation section.

KeywordIndexEntry

@Serializable

data class KeywordIndexEntry(val id: String, val title: String, val section: String, val resourcePath: String, val navOrder: Int, val keywords: List<String>, val aliases: List<String> = emptyList(), val charCount: Int, val iconId: String? = null)

Build-time keyword index entry decoded at runtime.

ModelReadiness

sealed interface ModelReadiness

Model readiness state for download/lifecycle UX.

SourceRef

@Serializable

data class SourceRef(val id: String, val title: String)

Reference to a source doc page shown as a chip in Chirpy replies.

TranslationSource

enum TranslationSource : Enum<TranslationSource>

Indicates the source of displayed page content for translation attribution.