Ctrlk
Customer Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Using AI Code Documenter

Written for the Old UI

This article was written for the old UI. The instructions are still usable, but the screenshots are outdated. In some cases, items referenced in the instructions have moved or changed. If you cannot find an item, see the Where Did It Go article.

Overview

This article explains how to use the AI Code Documenter to automatically generate documentation for a selected component. It helps teams create clear, well-structured code documentation that you can commit to the branch.

Default AI Limitations

By default, Flosum provides a free shared DeepSeek AI model for DevOps through DeepSeek’s API. Because it is shared across tenants, performance and availability depend on system load and token capacity. During heavy usage, you may see higher latency or temporary errors. To avoid this, you can add your own custom AI model. See the following article.

Best Practices

  • Run AI Code Documenter on stable code to avoid regenerating comments repeatedly.

  • Always review AI comments before committing to ensure accuracy and correct terminology.

  • Commit in small, logical chunks to keep review and rollback simple.

Using AI Code Documenter

1

Select a Branch and Component

  1. Click Code from the left sidebar menu.

  2. Click the branch that contains the component you want to document.

  3. Click the component you want to document.

2

Create Documentation

  1. Click AI Tools next to Edit.

  2. Click AI Code Documenter from the dropdown menu.

  3. While the documentation is being generated, AI is generating... is displayed.

  4. When AI Code Documenter finishes, the difference viewer opens, with the original on the left and AI changes on the right.

  5. Review the changes and make any necessary edits.

  6. Click Commit changes.

  7. Enter a Commit message.

  8. Click Commit.

PreviousUsing AI Test Class
NextDevOps CLI

Last updated

Was this helpful?