Skip to main content

Accessing Generated Results

When a task completes successfully, Smart Engineering exposes generated output in the repository workspace, the global documentation view, graph views, and downloadable .zip packages when available.

When to use​

  • Use documentation to read generated pages inside the application.
  • Use download when artifacts need to be shared, archived, or edited outside the application.
  • Use the graph to investigate technical relationships and dependencies in the analyzed code.

Documentation​

Open /repositories/:repositoryId/documentation to read documentation for one repository, or /documentation to start from the global documentation view.

Documentation is loaded on demand:

  1. The app fetches the available documentation pages.
  2. It builds the side navigation.
  3. It opens the first available page by default.
  4. It fetches page content when the user navigates.

This avoids loading all content at once and lets users browse the real documentation pages. The documentation view lets you:

  • Load documentation for the repository.
  • Select a repository with available documentation.
  • See unavailable repositories separately.
  • Search files or categories.
  • Navigate the side tree.
  • Open Markdown pages.
  • Read rendered Markdown.
  • Open Mermaid diagrams.
  • Reload documentation.
  • Return to the previous screen without entering a loop.
  • Download results when a package is available.

The page includes states for selecting a repository, loading documentation, loaded documentation, empty documentation, load errors, and filtered results with no matches.

Downloading the result package​

You can also download the generated result from a successful task.

  1. Open the completed task.
  2. Click Download Results.
  3. Extract the downloaded .zip file.
  4. Open the generated HTML or Markdown files locally.

Depending on the selected task options, the package can include documentation, diagrams, backlog artifacts, and supporting files.

Generated documentation is available as rendered content in the app and as source files for review or customization outside the app. HTML output can be opened in a browser, while Markdown output can be opened in an IDE or documentation tool.

Repository graph​

Open /repositories/:repositoryId/graph to explore relationships identified in the analyzed code. The graph helps technical users investigate nodes, relationships, files, code elements, dependencies, and references.

You can search files, select files or code elements, inspect references, open related documentation, and use AI assistance when it is configured.

AI assistance depends on the models and configuration available to the organization.

Global graph​

Open the global graph when you need to work outside a specific repository workspace. It has two modes:

  • Select existing repository: choose an available repository and load its graph. Repositories without source code should not appear as loadable options.
  • Upload code: upload a .zip file to generate a graph from the provided code.

Cumulative content​

Generated documentation can be cumulative. For example, after running a technical documentation task and then a backlog generation task, later result packages can include information produced by both tasks.

Expected result​

You should be able to navigate live documentation by page, explore technical relationships through repository or global graph flows, use AI chat when configured, and download a package with generated artifacts when available.

See also​