Live Docs: An Interactive Guide
A Live Docs page is more than a static document; it’s an interactive workspace designed to help you understand, discuss, and improve your project’s knowledge base. Here are the key features you can use to engage with your documentation.
Refresh Content On-Demand
While Sequa automatically checks for stale content, you can trigger a manual update for any page at any time. In the page header, simply click the “Refresh” button.
This action queues a background job that immediately regenerates all Auto sections on the page, ensuring you are always looking at content generated from the most recent version of your codebase.
Chat with Page Context
Have a specific question about the content on a page? Use the embedded chat at the bottom of the screen.
When you ask a question here, Sequa automatically uses the entire content of the current page as context. This allows you to ask highly specific questions and get answers that are grounded in the information presented in both the Static and Auto sections. It’s the perfect tool for clarifying a detail or digging deeper into a topic without leaving the page.
Share a Direct Link
To direct a team member to a specific page, click the “Share” button in the header. This copies a stable, permanent URL to your clipboard. This is ideal for referencing documentation in pull requests, task descriptions, or team chats.
View Section History
For any Auto section, you can view a complete history of its changes over time. This provides an audit trail of how the documentation has evolved in lockstep with your codebase.
Clicking on the “History” button for a section will open a view that shows:
- A list of all previous versions of the section’s content.
- A visual “diff” for each update, highlighting exactly what lines were added, removed, or changed.
This feature is incredibly powerful for understanding the impact of recent commits on a specific piece of functionality.
Add a Learning to Improve AI Content
Sometimes, an Auto section might be missing context or include information that isn’t quite right. The “Add Learning” feature empowers you to teach Sequa’s AI how to do better next time.
When you add a learning, you provide a specific instruction that Sequa will use to guide the next regeneration of that section. For example:
- “When describing the
UserService, make sure to include a section on its error handling and retry logic.” - “Exclude any internal-only functions from the public methods list.”
- “The overview should also mention that this service communicates with the Stripe API for payment processing.”
This feedback loop is the key to creating highly accurate, comprehensive AI-generated documentation that is tailored to your team’s specific needs.
This concludes the “LIVE DOCS” section.
Next up in the SEQUA MCP section: Overview