Documentation
¶
Overview ¶
Package main is where the base binary will be built from.
From this base location, sub-directories are used to capture models and business logic as required, grouped into their appropriate locations.
The binary that is built from this package will begin an auto-docs process that encompasses a HTTP server, a data fetcher, and an internal data store.
Directories
¶
Path | Synopsis |
---|---|
Package data provides functionality to interact with sources of documentation data.
|
Package data provides functionality to interact with sources of documentation data. |
Package docs provides storage and retrieval for a series of data points based around a tree structure of page content.
|
Package docs provides storage and retrieval for a series of data points based around a tree structure of page content. |
Package server provides capabilities to manage and process incoming HTTP requests.
|
Package server provides capabilities to manage and process incoming HTTP requests. |
Click to show internal directories.
Click to hide internal directories.