Skip to content

Documentation outdated: “Errors” section no longer matches current ScanCode.io UI #2050

@farheenimam

Description

@farheenimam

Hi ScanCode.io team,

While following the “Review Scan Results (Web UI)” tutorial, I noticed that the documentation and the current UI no longer match:

The tutorial refers to an “Errors” area (or error section) in the project UI where you can see the number of errors in a project and review them. In the current ScanCode.io version (e.g. v36.x), the project page instead shows a “Messages” counter at the top, and I do not see a dedicated “Errors” box anymore.

From the changelog, I can see that ProjectError was migrated to a more generic ProjectMessage model with INFO / WARNING / ERROR severities, so it looks like the UI and terminology were updated accordingly, but the tutorial still uses the old wording.

What I’m seeing

  • Project header shows: Packages, Dependencies, Resources, Messages.
  • No separate “Errors” widget as shown/described in the tutorial.
  • I have attached screenshots taken from my local ScanCode.io instance that show the current UI.
Image Image

What I would propose

  • Update the tutorial text to refer to “Messages” instead of “Errors”, and explain that messages can be of type INFO / WARNING / ERROR.
  • Update the screenshots in docs/tutorial_web_ui_review_scan_results.rst so that they match the current project page layout (with the Messages counter instead of an Errors section).
  • Optionally add a short note that older screenshots/UI referred to “Errors”, which have since been generalized into project messages.

I’m happy to open a PR to update the .rst file and screenshots if this change in terminology is confirmed as the intended behavior.

Thanks for the great project!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions