Skip to content

README/FAQ: Unclear references to "the webviewer" #3986

@Chealer

Description

@Chealer

The README file's View a Project's Score section contains 2 references to "the webviewer", starting with the following:

To see scores for projects regularly scanned by Scorecard, navigate to the webviewer, replacing the placeholder text with the platform, user/org, and repository name: https://securityscorecards.dev/viewer/?uri=<github_or_gitlab>.com/<user_name_or_org>/<repository_name>.

It would clarify to define what that "webviewer" is or give some clue. Referring to the FAQ's Can I preview my project's score? question/answer would help a little, but that section also refers to the webviewer without first defining it.

As there is apparently no definition for now, having "the webviewer" link to https://securityscorecards.dev/viewer/ could be a start.

By the way The strange URL/link above also shows in the README. Either the link should encompass the whole "URL", stop before the query string, or it should be removed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/docsImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions