Documentation
¶
Index ¶
- func MakeURL(baseURL, revision, path string) string
- type CodeSearchResult
- type Config
- type DocumentURL
- type Source
- func (s Source) ChangesSince(ctx context.Context, revision string) (iter.Seq[Update], string, func() error)
- func (s Source) Get(ctx context.Context, path, revision string) (string, error)
- func (s Source) Search(ctx context.Context, query string, limit int) ([]CodeSearchResult, error)
- func (s Source) Suggest(ctx context.Context, path, revision, content string) (string, error)
- func (s Source) URL() string
- type Update
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CodeSearchResult ¶ added in v0.0.23
type Config ¶
type Config struct {
Sources []Source `yaml:"sources" validate:"required,dive"`
}
func LoadConfig ¶
type DocumentURL ¶ added in v0.0.23
type DocumentURL struct {
BaseURL string // e.g., "https://github.com/owner/repo"
Revision string // e.g., "main"
Path string // e.g., "docs/README.md"
}
DocumentURL represents the parts of a document URL
func ParseURL ¶ added in v0.0.23
func ParseURL(url string) (*DocumentURL, error)
ParseURL parses a document URL into its component parts
type Source ¶
type Source struct {
Name string `yaml:"name" validate:"required"`
Type string `yaml:"type" validate:"required,oneof=github"`
GitHub *gitHubSource `yaml:"github,omitempty" validate:"required_if=Type github"`
}
func (Source) ChangesSince ¶
Click to show internal directories.
Click to hide internal directories.