Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include docs for API in the website #209

Open
naveensrinivasan opened this issue Sep 18, 2022 · 4 comments
Open

Include docs for API in the website #209

naveensrinivasan opened this issue Sep 18, 2022 · 4 comments
Assignees
@olivekl
Labels
documentation Improvements or additions to documentation

Comments

@naveensrinivasan
Copy link
Member

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

https://securityscorecards.dev/#run-the-checks
@naveensrinivasan naveensrinivasan added the documentation Improvements or additions to documentation label Sep 18, 2022
@naveensrinivasan
Copy link
Member Author

@olivekl Assigned it to you. If you think this doesn't apply to you, please let me know; I can take it.

@olivekl
Copy link

olivekl commented Sep 19, 2022

@naveensrinivasan I'd like to help but won't have the cycles for a while. I'd be able to edit if you can get it started!

@azeemshaikh38
Copy link
Contributor

@naveensrinivasan any specific docs you had in mind? Meaning what info do you think is currently missing ?

@naveensrinivasan
Copy link
Member Author

@naveensrinivasan any specific docs you had in mind? Meaning what info do you think is currently missing ?

The website doesn't have any reference to the API. We should add a reference to the API. Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@olivekl olivekl

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@naveensrinivasan @azeemshaikh38 @olivekl