Fathom.Guide (fathom v0.1.0)

Copy Markdown View Source

The agent-facing documentation for a project's program database.

mix fathom.install writes this into the project's AGENTS.md. It is the part that decides whether the database gets used: an agent that cannot see the schema will fall back to grep, and an agent given the schema with no worked examples will write queries that return nothing and then fall back to grep anyway.

Summary

Functions

Markers delimiting the generated section, so it can be regenerated in place.

The full generated section, including its markers.

Functions

markers()

Markers delimiting the generated section, so it can be regenerated in place.

section(db_path)

The full generated section, including its markers.