Skip to main content

Documentation sites for agents

LitPage is a documentation website builder for product teams writing for developers and AI agents. Organize guides by product or topic, edit in Markdown or visually, and share a direct link to every published article.

LitPage documentation with root links, an article sidebar and an On this page outline.

See how readers move through your docs

Open a guide, choose a documentation root at the top, find related articles on the left, and jump to a heading from On this page.

  • Switch topics

    Give distinct topics their own top-level roots. Start at the root that matches what you need.

  • Find another guide

    The article sidebar shows the current root’s published guides and their groups and folders.

  • Jump to a section

    Use the article outline to skip to steps, examples or troubleshooting.

    See an article outline

Give each set of docs a clear home

A root is a top-level area in your docs site. Start with a root for each distinct product or audience. Within a root, group related articles by the task a reader wants to finish.

  • Example root · Product guides

    Add a Getting started group and a Setup folder. Put Install, Configure and Check your setup in that folder so readers can complete those tasks in order.

  • Example root · CLI reference

    Keep command reference and error recovery in a separate root when readers need a different navigation path. Link from setup to the exact command they need.

  • Build out the structure as you write

    Prepare an empty folder and add multiple articles as they are ready. Check the published navigation after adding or moving a guide.

  • Maintain each language separately

    Organize documents in language-specific roots. Review the article titles, navigation and links in each language you publish.

Go from an outline to a public guide

Start with one task a reader needs to finish. The document editor keeps the body, navigation and publishing controls together.

  1. Create a root and choose a folder

    Name the root for the product or topic. Add a group or folder for related articles, then create the guide where you want readers to find it.

  2. Write in the editor that fits the task

    Use the visual document editor for prose. Switch to Markdown source for code examples or an agent’s draft. Save the article and inspect the result.

  3. Preview and publish the reviewed article

    Check the draft’s headings, examples and links. Publish it, then open the public URL and verify the current root, sidebar and article outline.

  4. Update the guide when the product changes

    Revise the steps and expected result together. Preview the revision, then publish it and check the links people already use.

Publish Markdown with the LitPage CLI guide in Source mode, with Markdown and CLI commands.

Review an agent’s draft in the document editor

Ask your coding agent for Markdown. Open it in Source, verify the commands and expected results, then preview the guide before you publish.

Write guides people and agents can use

Make each public article useful on its own. Give readers a direct URL and enough context to know whether the instructions fit their task.

  • Name the task in the heading

    Use a title such as Configure the CLI. State the supported version and prerequisites near the top so a reader can choose the right guide.

  • Show the expected result in text

    Put commands in code blocks and explain what success looks like. Include exact errors where they help, plus one recovery step a reader can check.

  • Link to the exact next step

    Use descriptive links to published articles or section anchors. Open the public links and check that the headings and examples can be read without a login.

  • Review the article’s search appearance

    Set a title and summary that describe the task. Open the published URL in the intended language and check its links and article outline.

  • Keep a human in the release workflow

    An agent can draft the Markdown. A reviewer checks examples and scope in LitPage before publishing. See the public CLI guide for the separate Blog workflow.

    Read the CLI publishing guide

Questions about publishing documentation

How LitPage handles structure, editing, publishing and agent workflows.

  • Can I organize more than one set of docs on a site?

    Yes. Use a documentation root for each product or topic. Each root can have groups and folders, and a folder can hold multiple articles. The top-level switcher takes readers to published content in the selected root.

  • Can I write in Markdown and see how the article will look?

    Yes. Switch between the visual document editor and Markdown source. Save the draft and open its preview to check headings, examples and links before publishing.

  • Can visitors see my drafts or empty folders?

    Visitors see published articles. Keep unfinished guides as drafts and prepare folders as you organize them. Check the public sidebar after publishing to see which articles readers can open.

  • What can an AI agent do with the published docs?

    An agent with web access can open the same public article links you share with people. Clear headings, prerequisites, examples and direct links help it find the relevant instructions. Retrieval depends on the agent and the access it has.

  • What does the public LitPage CLI workflow cover?

    The public CLI guide shows how to save a Markdown Blog draft and publish it to an existing LitPage site using a workspace API key. To choose a documentation root and folder for a new Docs article, use the document editor.

  • What is the status of publishing through MCP?

    Planned. Use the document editor to save, preview and publish Docs today.

Publish your first guide

Create a site, choose a root and write one guide that helps a reader finish a real task.