Skip to main content

Advanced Usage

This page covers practices for operating Smart Engineering efficiently after the basic repository and process flow is working.

Resume from the overview​

The repository overview at /repositories/:repositoryId is the best place to understand what is missing. It can show:

  • General repository information and organization.
  • Creation and update dates, and storage type.
  • Current status and the repository journey.
  • The getting-started checklist and the recommended next action.
  • Recent processes.
  • Pre-analysis data, LLM cost estimates, and model recommendations when available.
  • Error messages when a failure exists.

When you are unsure what to do next, start from the overview and follow the recommended action.

Use the command palette​

Open the command palette from the header or with the keyboard shortcut. It groups actions into Navigation, Agentic, Personalize, Modernization, Current repository, and Administration. Available actions depend on the current repository, enabled features, and account permissions.

Contextual tutorial​

Contextual, per-screen guidance is available on many screens. A reminder appears in the sidebar when a tutorial for the current flow has not been opened yet.

Global graph​

Open the global graph to use graph features outside a repository workspace. You can select an existing repository with source available or upload a .zip file to generate a graph.

Cost Explorer​

Administration → Cost Explorer estimates the cost of a documentation run before you start it, from repository measurements or a manual workload. See Cost Explorer.

API keys​

The API keys screen at /modernization/api-keys (Administration → API Keys) supports programmatic integrations. You can list keys, create a key, copy it at creation time, revoke a key, delete a key, and refresh the list.

Copy the key when it is shown. It is not displayed again after creation.

Model and cost practices​

Generated output depends on model selection and language choices. Use lighter models for simple enrichment, indexing, and straightforward documentation. Use stronger models for architecture analysis, diagrams, and comprehensive overviews. Output languages other than English can add translation cost. Use Cost Explorer to compare options first.

Settings​

Open /settings to adjust model and app behavior. Chat and process creation depend on the models available to the organization.

Operational tips​

  • Keep the active organization visible and correct before creating repositories or processes.
  • Follow the natural sequence: create repository, index source, confirm pre-analysis, review insights, create a process, monitor it, consume documentation.
  • Use filters when a repository has many processes or documentation files.
  • Prefer restarting failed or cancelled processes before creating duplicate work.
  • Download successful results when the artifacts must be shared outside the app.

Experience components​

ComponentRole
SidebarNavigation for agentic, repository, modernization, and administration routes.
HeaderGlobal controls, organization selector, and command palette entry.
Command paletteFast search and execution of global or repository-specific actions.
Repository workspace tabsOverview, Indexing, Insights, Source Code, Processes, Documentation, Graph, Settings.
BreadcrumbLocation inside the repository flow.
Indexing panelConnects a Git repository or receives a .zip upload, and shows upload history.
Insights panelShows metrics, language breakdown, detected stack, and cost estimates.
Pre-analysis confirmation dialogReviews files, lines, tokens, and languages before indexing.
Repository cardsRepresent repositories in the listing.
Process cardsRepresent process executions and actions.
Process logsShow recent execution details.
Documentation viewerRenders Markdown, supports search, and opens diagrams.
Graph canvasShows code relationships, references, and related files.
API key dialogsManage 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 processes or documentation files.
  • Review pre-analysis and insights before creating processes.
  • Use process logs before restarting failed work.

See also​