Add godoc documentation and README with code structure

Add comprehensive godoc comments to all exported types, functions,
and constants throughout the codebase. Create README.md documenting
the project architecture, execution flow, database schema, and
component relationships.
This commit is contained in:
2025-12-27 12:30:46 +07:00
parent 23dcdd800b
commit 95bbb655ab
8 changed files with 299 additions and 35 deletions

View File

@@ -1435,7 +1435,7 @@ func (d *Database) GetASDetailsContext(ctx context.Context, asn int) (*ASN, []Li
return &asnInfo, allPrefixes, nil
}
// ASPeer represents a peering relationship with another AS
// ASPeer represents a peering relationship with another AS including handle, description, and timestamps.
type ASPeer struct {
ASN int `json:"asn"`
Handle string `json:"handle"`