Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
CommandsDir string
ProjectDocsDir string
ProjectRootDir string
ExcludeDirs []string
MaxFileSize int64
ServerName string
Version string
CacheTTL time.Duration
}
Config defines server configuration
type DocInfo ¶
type DocInfo struct {
Name string `json:"name"`
Filename string `json:"filename"`
Source string `json:"source"`
Size int64 `json:"size,omitempty"`
TooLarge bool `json:"too_large,omitempty"`
Description string `json:"description,omitempty"`
Tags []string `json:"tags,omitempty"`
}
DocInfo represents information about a documentation file
type ListOutput ¶
ListOutput contains the result of listing all documentation files
type ReadOutput ¶
type ReadOutput struct {
Path string `json:"path"`
Content string `json:"content"`
Size int `json:"size"`
Source string `json:"source"`
}
ReadOutput contains the result of reading a documentation file
type SearchInput ¶
type SearchInput struct {
Query string `json:"query"`
}
SearchInput represents input for searching documentation
type SearchMatch ¶
type SearchMatch struct {
Path string `json:"path"`
Name string `json:"name"`
Score float64 `json:"score"`
Source string `json:"source"`
}
SearchMatch represents a single search result
type SearchOutput ¶
type SearchOutput struct {
Results []SearchMatch `json:"results"`
Total int `json:"total"`
}
SearchOutput contains search results
Click to show internal directories.
Click to hide internal directories.