Advanced Usage
This page covers practices for operating Smart Engineering efficiently after the basic repository and task flow is working.
Resume from the overview
The repository overview at /repositories/:repositoryId/overview is the best place to understand what is missing. It can show:
- General repository information.
- Organization.
- Creation and update dates.
- Storage type.
- Current status.
- Recommended next action.
- Repository journey.
- Recent tasks.
- Pre-analysis data.
- LLM cost estimates and model recommendations when available.
- Usage measurement summary when enabled.
- Error messages when a failure exists.
When a user is unsure what to do next, start from the overview and follow the recommended action.
Use the command palette
Open the command palette from the app controls or the configured shortcut to move quickly between repository, knowledge, and administration screens. Available actions depend on the current repository, enabled features, and account permissions.
Contextual tutorial
Start a contextual tutorial from the command palette when you need guided help on the current screen.
Global graph
Open the global graph to use graph features outside a repository workspace. Users can select an existing repository with source code available or upload a .zip file to generate a graph.
Usage measurement
Usage measurement is available from the administration area when usage tracking is enabled for the environment. It is not part of the repository workspace tabs.
When enabled, usage measurement can show usage summaries, history, and recent events.
If the feature is disabled, the app redirects users to a safe screen such as the repository list or repository overview.
API keys
The API keys screen at /modernization/api-keys supports programmatic integrations. Users can list keys, create a new key, copy it at creation time, revoke a key, delete a key, and refresh the list.
Copy the key when it is shown. Credentials of this kind are normally not displayed again after creation.
Model and cost practices
Generated output can depend on model selection and language choices. Use lighter models for simple enrichment, indexing, and straightforward documentation generation. Use stronger models for architecture analysis, diagrams, and comprehensive overviews. Output languages other than English can add translation cost.
Settings
Open /settings to adjust model and app behavior. Chat and task creation can depend on the models available to the organization.
Operational tips
- Keep the active organization visible and correct before creating repositories or tasks.
- Follow the natural sequence: create repository, upload source, review pre-analysis, create task, monitor task, consume documentation.
- Use filters when a repository has many tasks or documentation files.
- Prefer restarting failed or cancelled tasks before creating duplicate work.
- Download successful results when the artifacts must be shared outside the app.
Experience components
| Component | Role |
|---|---|
| Sidebar | Main navigation for repository, knowledge, and administration routes. |
| Header | Global controls, user information, and command palette entry. |
| Command palette | Fast search and execution of global or repository-specific actions. |
| Repository workspace tabs | Navigation between overview, source, tasks, documentation, and graph. |
| Breadcrumb | Location inside the repository flow. |
| Repository setup stepper | Shows the details, source, and indexer or pre-analysis steps. |
| Repository cards | Represent repositories in the listing. |
| Task cards | Represent task executions and task actions. |
| Task logs | Show recent execution details. |
| Upload dropzone | Receives the .zip file by selection or drag and drop. |
| Pre-analysis panel | Shows metrics, costs, and recommendations when available. |
| Documentation viewer | Renders Markdown, supports search, and opens diagrams. |
| Graph canvas | Shows code relationships, references, and related files. |
| Usage measurement tables | Show usage summary, history, and events. |
| API key dialogs | Manage programmatic access keys. |
Feedback components
The app uses loading states, empty states, retryable errors, alerts, confirmation dialogs, and longer-operation indicators to keep user actions clear.
Usage principles
- Always confirm the active organization before creating or searching repositories.
- Follow the recommended sequence shown by the repository status.
- Use the overview to resume work after interruptions.
- Use the command palette for fast navigation.
- Use filters when there are many tasks or documentation files.
- Review pre-analysis before creating tasks.
- Use task logs before restarting failed work.