Doxloop

Create professional documentation from your product's source code.

Doxloop understands your product, plans the right documentation, writes the pages, and checks the result.

Create your first docs

Go from source code to a local documentation preview.

See an example

See the command and the result it produces.

Start with one command

After installing Doxloop, run it from your product directory and describe the documentation you want:

bash

cd your-product
doxloop create \
  --source . \
  --output ../your-product-docs \
  "Create documentation for developers adopting this product. Include a quickstart and the main workflows."

When authoring finishes, Doxloop reports the documentation project and the number of pages it created:

text

Documentation created successfully.

Pages created: 8
Documentation project: /projects/your-product-docs
Product source files included in deployment: 0

Open the local preview:

bash

cd ../your-product-docs
doxloop preview --open

The preview uses http://127.0.0.1:4321 by default.

Already have documentation?

After your product changes, run this command from its documentation project:

bash

doxloop update "Update affected pages for the latest product changes."

Doxloop combines your instruction with the relevant product changes and asks the authoring workflow to update the affected pages.