index

package

v0.4.0 Latest Latest Go to latest Published: Sep 21, 2026 License: AGPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/archdochq/archdoc

Links

Open Source Insights

Documentation ¶

Overview ¶

Package index generates INDEX.md, the published view of every derived relationship. It is generated rather than maintained by hand because a frozen document cannot be edited to record what happened to it later.

Index ¶

func Generate(r *repo.Repo) []byte
func StatusOf(status string, backfilled, obsolete bool) string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Generate ¶

func Generate(r *repo.Repo) []byte

Generate renders the index for a repository. The output is deterministic: `archdoc index --check` compares it byte for byte against the committed file.

func StatusOf ¶

func StatusOf(status string, backfilled, obsolete bool) string

StatusOf renders a status with its qualifiers, comma-separated in a fixed order, so a document that is both reads as one cell rather than two special cases.

Types ¶

This section is empty.

Source Files ¶

View all Source files

index.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL