SAFA’s Early-Access Document Generation release is a limited version of our document generation capabilities, where users can generate system-wide code documentation without technical assistance. Our Early Access release generates a limited subset of documentation, specifically:

<aside> 🚀 Self-Service Document Generation

</aside>

Self-Service Process


1. Connect GitHub

SAFA’s Early Access Self-Service Platform presents supports GitHub code bases. This is only limited to our Self-Service platform; if you are using another provider, contact us to import your data.

To import code, you will need to connect to our GitHub integration, and be a contributor on the repository. Your organization will also need to approve our integration. If the repository is public, you can enter the organization and repository name regardless of your account’s access.

<aside> 🚨 Our Integration only requires read access to your selected repository. All data you provide to SAFA will not be used to train our language models, and will not be exposed to Third-Party Data Providers. Read more at Data Security and Privacy

</aside>

2. Select Your Repository

SAFA is Programming Language Agnostic, but our Self-Service offering has an upper limit of 1000 Code Files. For codebases above this limit, SAFA will still provide free Project Summaries and Code Summaries, but you cannot generate upstream documentation. Contact us if your repo is above the limit, and we will generate it separately.

By default, SAFA will only import code files from a target folder. If you would like to generate documentation for a specific subset of your code, select “Advanced Configuration” to specify include/exclude paths and file extensions.