# Troubleshoot AI and Technical Documentation Problems

This page helps you resolve problems with AI-generated technical documentation, API references, code examples, and documentation that no longer matches your source. Addressing these issues helps keep your team’s Technical Docs accurate, useful, and ready to share.

## Overview

Atloria’s **Technical Docs** area helps you generate and maintain technical documentation from your project. You can start documentation generation, review API reference content, add code examples, inspect source material, and export completed documentation.

You may need this page when generation remains in progress, an API reference does not contain the expected details, a code snippet looks incorrect, or documentation appears outdated after changes to your project. Start by checking the generation status and reviewing the relevant source before making documentation changes.

Technical documentation can cover multiple parts of a project, including frontend components, backend services, databases, API schemas, configuration, documentation, and infrastructure. When a page is incomplete, the underlying source may not have been successfully analyzed, may have generated warnings, or may not yet be reflected in the current documentation.

> 📷 _Screenshot pending: The Technical Docs screen showing the Generation section, generation status, and documentation actions._

## Prerequisites

Before you begin troubleshooting, make sure you have:

- Access to the correct project’s **Technical Docs** area.
- Permission to view project documentation and source information.
- A completed or currently running documentation generation.
- The relevant project changes available for review if you are checking documentation freshness.
- A clear understanding of whether you are reviewing:
  - Generated technical documentation
  - An **API Reference**
  - A code example or snippet
  - Source information displayed through **View Source**
- Enough time for generation to complete before starting another generation attempt.

## Step-by-Step Instructions

1. **Open the project’s Technical Docs area.**

   Open your project and select **Technical Docs**. This is the central location for generated documentation, API reference content, source review, and export actions.

   If you are unsure whether documentation exists yet, look for **Generate Documentation →**. This indicates that you can begin a new documentation generation process.

2. **Check the current generation status.**

   Select **Generation** to review the documentation generation state. During processing, Atloria displays **4. Generation Running**.

   If generation is still running, wait for it to finish before judging whether content is missing or incomplete. Starting another generation while one is already running can make it harder to determine which result you are reviewing.

   If you need to stop the current process, select **■ Cancel Generation**. Use this only when the generation appears stuck or when you need to make major source changes before generating again.

3. **Review missing or incomplete generated content.**

   If expected documentation is absent after generation finishes, return to **Technical Docs** and identify the affected area. For example, determine whether the missing information belongs to frontend behavior, backend processing, a database area, API schema, configuration, or infrastructure.

   Documentation generation may process project information across these areas in stages. A successful parse can complete with no errors, while another result may complete with warnings. If you see incomplete coverage, review the affected source information and generate the documentation again after the relevant project content is available.

4. **Investigate API reference issues.**

   Select **API Reference** when endpoint or interface documentation appears incomplete, unclear, or inconsistent with the project.

   Review the generated API reference before exporting it. If an option for a compact presentation is available, select **compact** when you need a shorter view for quick review. Use the standard documentation view when you need more detail.

   If the API reference is missing expected information, inspect the related source content first. Then return to **Generation** and generate documentation again so the API reference can be refreshed from the latest available project information.

   > 📷 _Screenshot pending: The API Reference view with the compact style option and Generate button._

5. **Check code examples and snippets.**

   When documentation needs an example, select **Add code examples**. Review each example for relevance, completeness, and whether its language and formatting match the code you expect users to see.

   If a snippet appears incorrect, use **View Source** to compare the documentation with the source material. In the source review area, select **Source** to focus on the source version. If a comparison view is available, use it to identify differences between the displayed documentation content and the source content.

   Correct or update the source material as needed, then regenerate the documentation. Do not rely on an outdated snippet simply because it is formatted correctly; it must also reflect the current project behavior.

6. **Resolve documentation freshness problems.**

   If documentation was generated before recent project changes, treat it as potentially outdated. Check whether changed relationships or responsibilities are reflected in the documentation. For example, a component may render another component, use a hook or context, call an API, use a service, or query a model.

   Review the applicable source through **View Source**, then run generation again from **Generation**. After the new result is available, verify that the affected technical documentation, API reference, and code examples have been updated.

7. **Export only after review.**

   Select **Export Documentation** only after you have confirmed that generation has finished and the documentation is current. Exporting before resolving known problems can distribute incomplete API details, stale examples, or missing technical sections.

## Tips and Best Practices

- **Wait for generation to finish.** When **4. Generation Running** is displayed, content may not yet represent the final result. Avoid treating an in-progress result as a documentation defect.
- **Use source review to validate AI output.** Select **View Source** whenever generated text, an API reference, or a snippet appears questionable. This is especially important after recent project changes.
- **Regenerate after meaningful changes.** Refresh documentation after changes to components, hooks, contexts, services, API behavior, data access, configuration, or infrastructure. These changes can affect relationships described in technical documentation.
- **Check warnings carefully.** A generation process can complete with warnings rather than errors. In this case, review the affected content for gaps instead of assuming the entire documentation set is unusable.
- **Keep examples focused.** Use **Add code examples** for examples that clarify implementation or usage. Avoid adding examples that repeat information already clear in the surrounding documentation.
- **Review API references separately.** A complete general technical document does not guarantee that every API reference detail is present or easy to understand. Open **API Reference** and validate it independently.
- **Export last.** Use **Export Documentation** as the final step in your review process, not as a substitute for validating generated content.

## Related Pages

- [Generate Technical Documentation](#)
- [Review an API Reference](#)
- [Add Code Examples to Documentation](#)
- [View Documentation Source](#)
- [Export Technical Documentation](#)
- [Resolve Project Issues](#)

## Troubleshooting

### Generation remains on “4. Generation Running”

**Problem:** The **Generation** section continues to show **4. Generation Running**, and the documentation is not ready to review.

**Cause:** Generation is still processing project information, or the current generation may no longer be progressing as expected.

**Solution:** Wait briefly and refresh your view of **Generation**. If the status does not change and you need to stop the process, select **■ Cancel Generation**. Review any relevant source changes, then start documentation generation again using **Generate Documentation →**.

### The API Reference is incomplete or does not match the project

**Problem:** The **API Reference** does not include expected details or appears inconsistent with current project behavior.

**Cause:** The reference may have been generated before the latest project changes, or the relevant source information may not have been fully available during generation.

**Solution:** Select **View Source** and review the related source information. Confirm that the required API behavior is present, then return to **Generation** and generate the documentation again. Reopen **API Reference** and validate the updated result before exporting.

### A code snippet is outdated or incorrect

**Problem:** A code example does not match the current implementation or is not useful to readers.

**Cause:** The documentation may have been generated from earlier source information, or the example may not reflect changes in the component, service, API, or other related area.

**Solution:** Select **View Source**, then use **Source** to review the current source material. Update the underlying project content if needed, regenerate the documentation, and use **Add code examples** to include a clearer or more current example.