Skip to main content

Accessing Your Task Results

Once your modernization task is successfully completed, a "Download Results" button will become available on the Task Progress Visualization page. This allows you to access the generated documentation, backlog, or any other artifacts from your task.

Downloading and Viewing the Output​

The results are packaged in a .zip file for easy download. The generated documentation is provided in HTML and Markdown formats, giving you both a ready-to-view website and the raw source files for further customization.

To view the generated content, follow these simple steps:

  1. Download the File: Click the "Download Results" button to save the .zip file to your computer.
Task results screen showing highlighted download button
  1. Extract the Contents: Unzip the downloaded file to a location of your choice. This will create a folder containing all the generated files.
  2. Navigate and View:

    • After extracting, you will see a folder structure similar to this:

      Extracted folder structure showing html and markdown directories

    • To view the website, navigate into the html directory.

      Contents of the html directory with index.html

    • Open the index.html file in your web browser to see the fully rendered documentation.

      Final documentation rendered in a web browser
See a Live Example

Want to see what a fully generated documentation site looks like? You can explore a live example in our repository here.

  • To view the source files, you can open the folder using an IDE of your choice.

Dynamic and Cumulative Content​

It's important to understand that the contents of the downloaded .zip file will vary depending on the options you select in the task creation toggles. The documentation is generated dynamically based on your choices.

Additionally, the generated documentation is cumulative. For example, if you first run a "Technical Documentation" task and then a "Backlog Generation" task, the second download will contain the information from both tasks.

That's it! You can now explore the customized results of your modernization task.