ossf/scorecard-webapp

Include docs for API in the website

Open

#209 opened on Sep 18, 2022

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Go (30 forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository metrics

Stars
 (29 stars)
PR merge metrics
 (PR metrics pending)

Description

The website doesn't have docs for the new API.

https://securityscorecards.dev/#run-the-checks

Contributor guide

Research direction
Add API documentation to the website by following the existing documentation structure. Refer to the API source code for accurate details. Create a new page or section and ensure links work.
Tech stack
go
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85