How It Works

Cartographer is designed to seamlessly integrate with your development workflow by automatically generating and maintaining documentation based on your codebase. It operates within your CI/CD pipeline to ensure documentation stays up-to-date with minimal manual intervention.

Cartographer is compatible with any programming language.

Cartographer monitors files that have been explicitly tagged for documentation. When your pipeline runs, Cartographer uses Git to detect any changes or additions to those tagged files. This allows it to intelligently determine whether new documentation should be created or existing documentation should be updated.

If changes are detected, Cartographer automatically generates or updates the corresponding documentation to reflect the latest state of your code.

In cases where no changes are found in the tagged files, Cartographer takes no action, allowing your pipeline to proceed without unnecessary processing. This efficiency helps maintain optimal performance while ensuring documentation accuracy only when it's needed.

If you prefer not to integrate Cartographer directly into your CI/CD pipeline, we also offer a Repository Scan feature. This option allows you to trigger a one-time scan of your repository directly from the dashboard. Cartographer will analyze your codebase for tagged files and generate or update documentation accordingly.

Additionally, you can manually upload individual code files if you want to generate documentation without connecting a repository. These flexible options make it easy to get started and keep your documentation up to date, regardless of your workflow.