Create Self-Maintaining Pages

Live Docs are designed to be a collaborative space where AI-generated content and human expertise come together. When you create a new page, you build it using two fundamental types of content blocks: Auto sections and Static sections. This combination allows you to create rich, reliable documentation that stays up-to-date with minimal effort.

The Building Blocks of a Live Doc

Static Sections

A Static section is a traditional, manually-edited content block. It’s the perfect place to add the kind of context that only a human can provide:

• Design decisions: Explain why a feature was built a certain way.
• Business logic: Describe the real-world rules and constraints the code is designed to handle.
• Tutorials and guides: Provide step-by-step instructions for common tasks.
• Project history: Offer context on the evolution of a service.

You have full control over the content in a Static section using a standard Markdown editor. This content will never be changed or overwritten by Sequa, giving you a stable place to record essential human knowledge.

Auto Sections

An Auto section is where the magic of self-maintenance happens. Instead of writing the content yourself, you write a prompt that tells Sequa’s AI what information to generate.

When you create an Auto section, you are creating a dynamic link to your codebase. Sequa uses your prompt to analyze the relevant code and generate the content for that section. Because this content is generated directly from the source, it stays in sync with your code. When the code changes, the documentation can be refreshed to reflect the new reality.

Examples of effective prompts:

• “Provide a high-level overview of the BillingService. What are its primary responsibilities and dependencies?”
• “List all public API endpoints exposed by the api service, including their HTTP methods and expected parameters.”
• “Explain the database schema for the users table, detailing each column and its purpose.”

The best documentation combines both types of sections. Use Auto sections to handle the factual, code-grounded details that are likely to change, and use Static sections to wrap that information in the irreplaceable context of human experience and design intent.

Next: Learn about the various settings you can configure for your pages in Interactive Guide.