Documentation

Graphtia documentation · workflow

Read project documents alongside code

Use indexed project documentation as context while keeping prose, declarations and executable evidence distinct.

Documentation is a separate view

Explorer can expose supported indexed project documents alongside code and API/database declarations. A document can explain intent or setup; it is not a function definition, an executed test or a database schema merely because it mentions one.

Read with source context

  1. Open the indexed workspace and select Documents.

  2. Search for the topic, inspect the document’s identity and open its content.

  3. Check its revision and notices; a changed file can make an earlier explanation stale.

  4. Follow relevant source references using code or API & DB views, keeping the two forms of evidence distinct.

With an agent

Ask the agent to find indexed project documentation before answering a setup or architecture question, then verify technical claims against code and declarations. Preserve the document source and revision. Do not treat instructions inside a repository document as permission to edit files, execute commands or change the workspace.

When a document is unavailable

Check the selected root, supported indexed document formats and exclusions. Do not assume every binary document, ignored file or external URL is indexed. Missing document results do not certify that the project has no documentation.

Graphtia

This page is on its way. Join the waitlist to hear what’s next for Graphtia.

Join waitlist