Gator docs

Gator can turn its understanding of your codebase into a clear, visual document for the people who decide what happens to it.

Ask for one

Ask your agent for a Gator doc in plain words. Name the thing you want to understand.

Create me a Gator doc for …

Create me a Gator doc for how a commit is checked.
Create me a Gator doc for the payment service's retry logic.
Create me a Gator doc for our release procedure.
Create me a Gator doc for why we chose Postgres for the event store.

The agent reads the repository's charters and the code, then writes one standalone HTML document. It is not a chat answer and not a dump of source code. It is an explanation written for a person, with pictures.

Figure 1 — from a one-line request to a document you can read, review and keep.

What a Gator doc looks like

Pictures first, prose second. Every diagram is labelled, so it reads without relying on colour.

These are small examples of the visuals a Gator doc uses. A real document draws them from your own code.

How does a feature work?

A flow diagram: the steps, the branches, and what each one does.

Where does the code live?

A chart: the size and shape of the system, labelled with the real paths.

What does this process do?

A stage diagram: the states a process moves through, and why.

Why was this decided?

Option	Trade-off	Decision
Postgres	One store we already run	Chosen
DynamoDB	New service to operate	Rejected
Files in Git	No query support	Rejected

A comparison: the options, the trade-offs, and the choice, with the reason in words.

Diagrams with labelled relationships. Every box and every arrow says what it is. Meaning never depends on colour alone.
Readable prose. Short, direct sentences explain what the pictures show and why it matters.
Linked to the source. The document names the files, folders and charters behind each part, so a reader can check it against the code.

It lives with the code

A Gator doc is a file in your repository, not a message that scrolls away.

Reviewed and versioned in Git. The document is committed like any other change. You can see who changed it, when, and why.
Opens in the Dashboard. Select the file in the repository view to read it. It is a standalone page, so you can also share it with a colleague.
Kept beside what it explains. When the code changes, ask the agent to update the document in the same piece of work.