Creating a Repository
Create a repository at /repositories/create to register the system that Smart Engineering will analyze. A repository must belong to the active organization.
When to use
- Use creation when a system is not registered yet.
- Use it to start a new documentation or modernization journey.
- Use it before uploading the source code that will be analyzed.
Before you start
- Confirm the active organization.
- Define a recognizable repository name.
- Prepare a description with enough context to guide generation.
Main fields
The creation flow collects the information needed to identify and contextualize the system:
| Field | Description | Guidance |
|---|---|---|
| Name | A clear repository name. | Use a name that teams can recognize later in lists, tasks, and generated documentation. |
| Description | A summary of the repository context. | Include business purpose, scope, important modules, integrations, risks, or known constraints. |
| Organization | The active organization context. | Confirm that the selected organization is the correct one before creating the repository. |
| Support information | Guidance displayed during the setup flow. | Use it to confirm what will be analyzed before uploading source code. |
Step by step
- Open repository creation.
- Confirm the active organization.
- Fill in name and description.
- Review the information in the setup stepper.
- Confirm creation.
- Continue to the source code step.
Screen components
The creation screen includes:
- Repository setup stepper.
- Repository details card.
- Creation confirmation dialog.
- Discard changes dialog.
- Supported indexer guidance.
Recommended description
A strong description improves the context available to generated artifacts. Include:
- The system's business goal.
- Main functional areas or modules.
- Key stakeholders or users.
- Important integrations.
- Technical risks or legacy constraints.
- Any modernization objective already known by the team.
Example:
This repository supports customer onboarding for the retail banking channel.
It includes account validation, document checks, eligibility rules, and
integration with the customer profile service. The modernization goal is to
document the existing flows and identify candidates for API extraction.
Expected result
After creation, the application redirects you to upload source code for the new repository.