Overview

Traditional documentation is a snapshot in time. It’s accurate the day it’s written, but with every new commit, it begins to decay. At scale, this documentation rot creates friction, slows down developers, and leads to costly mistakes.

Sequa’s Live Docs are fundamentally different. They are self-maintaining knowledge artifacts that are dynamically generated and updated directly from your source code. Instead of relying on manual updates, Sequa creates a living model of your codebase that evolves with your system.

How It Works: Continuous Synchronization

At the heart of Live Docs is a powerful analysis engine that continuously monitors your connected codebases.

Daily Freshness Checks: Sequa automatically runs checks every 24 hours to detect changes in your codebase. If it identifies new commits or modifications that could impact the documentation, it flags the relevant pages as stale.
On-Demand Regeneration: When a user visits a stale page, Sequa automatically regenerates its content in the background, ensuring the information presented is always based on the latest version of the code. You can also trigger a manual refresh at any time.
A Starting Point for Excellence: The out-of-the-box documentation provided by Sequa is a comprehensive and accurate starting point. It provides an instant, high-level overview of your services, their dependencies, and their core functions. From there, your team can refine and enrich these pages with a mix of auto-updating and static content, adding the human context that only developers can provide.

Scoped for Relevance

In a complex project, context is everything. A developer working on the API service doesn’t need to be swamped with documentation for the Auth Frontend.

Live Docs are structured around this principle. Documentation is organized within each Product you create in Sequa and can be further scoped to individual services. This ensures that when a developer navigates to the documentation for a specific service, they see only the information that is relevant to their immediate task.

This scoped approach transforms documentation from a monolithic library into a set of targeted, contextual guides that map directly to your system’s architecture.

Next: Learn how to explore your system’s structure with the Service Architecture View.

Overview

How It Works: Continuous Synchronization

At the heart of Live Docs is a powerful analysis engine that continuously monitors your connected codebases.

Daily Freshness Checks: Sequa automatically runs checks every 24 hours to detect changes in your codebase. If it identifies new commits or modifications that could impact the documentation, it flags the relevant pages as stale.

On-Demand Regeneration: When a user visits a stale page, Sequa automatically regenerates its content in the background, ensuring the information presented is always based on the latest version of the code. You can also trigger a manual refresh at any time.

A Starting Point for Excellence: The out-of-the-box documentation provided by Sequa is a comprehensive and accurate starting point. It provides an instant, high-level overview of your services, their dependencies, and their core functions. From there, your team can refine and enrich these pages with a mix of auto-updating and static content, adding the human context that only developers can provide.

Scoped for Relevance

In a complex project, context is everything. A developer working on the API service doesn’t need to be swamped with documentation for the Auth Frontend.

This scoped approach transforms documentation from a monolithic library into a set of targeted, contextual guides that map directly to your system’s architecture.

Next: Learn how to explore your system’s structure with the Service Architecture View.