Skip to main content

Smart Engineering Overview

Smart Engineering supports the code modernization journey. Users register a repository, upload source code, review the pre-analysis, create documentation tasks, and use the results to browse documentation, technical graphs, logs, and usage metrics.

After documentation is complete, users can create a Code Modernization project to understand the current application, prepare a modernization plan, and generate files for a new application through a guided assistant.

What you see depends on the active organization, the repository status, the available task options, enabled usage tracking, and the permissions assigned to your account.

When to use​

  • Use the module to document existing systems from source code.
  • Use it to understand structure, dependencies, languages, and code volume.
  • Use it to generate technical documentation, diagrams, and backlog artifacts.
  • Use it to investigate technical relationships in the repository graph.
  • Use it when a team needs to recover knowledge about a legacy or poorly documented system.

Before you start​

  • Confirm the active organization.
  • Make sure the correct repository will be created or selected.
  • Prepare the source code as a .zip file.
  • Confirm that your account can access the module and run tasks.

Access​

The app uses the authentication and permission model configured for the environment. When sign-in is required, unauthenticated users are redirected to the login screen. After sign-in, the app validates the active session with the API before exposing protected screens.

If your organization or module access is missing, contact the workspace administrator or project manager before creating repositories.

Understand the application​

AreaWhat it means
OrganizationContext that defines which repositories, tasks, documents, usage data, and metrics are available.
RepositorySystem that will be analyzed. It can include metadata, uploaded code, pre-analysis, tasks, documentation, graph, and usage data.
Source code.zip package analyzed by the app for pre-analysis, graph, and documentation.
Pre-analysisInitial repository summary with files, lines, stacks, cost estimates, context windows, and execution recommendations when available.
TaskExecution that can generate documentation, diagrams, backlog artifacts, or other selected results.
Repository workspaceArea with overview, source code, tasks, documentation, and graph.
Code ModernizationGuided project that uses completed repository documentation as the starting point for planning and generating a new application.
Command paletteFast command surface for finding screens and actions.

Step by step​

  1. Sign in to the application.
  2. Confirm the active organization.
  3. Create or open a repository.
  4. Upload the source code as a .zip file.
  5. Wait for processing and review the pre-analysis.
  6. Create a task.
  7. Monitor status, logs, and available actions.
  8. Read the generated documentation.
  9. Start a Code Modernization project when you want to plan and generate a new application.
  10. Explore the graph, references, and code inspector when you need technical context.
  11. Review usage measurement or download the result package when needed.

The protected app layout provides three main navigation aids:

  • Sidebar: groups repository, knowledge, and administration routes.
  • Header: exposes global controls, user information, and command palette access.
  • Command palette: lets you search screens and actions without navigating manually.

The sidebar can be collapsed. On mobile, it opens as a side panel. Repository actions are grouped under repository routes, knowledge routes cover documentation and graph exploration, and administration routes cover API keys and usage measurement when enabled.

The command palette can open repository, knowledge, and administration screens. Available actions depend on the current repository, enabled features, and account permissions.

Repository workspace​

The repository workspace is available at /repositories/:repositoryId. It shows a header, breadcrumb, current status, and tabs for the repository lifecycle:

  • Overview
  • Source Code
  • Tasks
  • Documentation
  • Graph Some tabs can be locked until source code or pre-analysis exists.

Usage measurement is not part of the repository workspace tabs. When enabled, it is available from the administration area and lets users select the repository inside that screen.

Expected result​

At the end of the flow, the repository should have processed code, available pre-analysis, one or more executed tasks, generated documentation, graph references, and usage data when usage measurement is enabled. When Code Modernization is used, its project also keeps the generated plan, documents, and files available for review or download.

See also​