Azure / Azure/azure-openapi-validator

README.md contains no install or usage instructions

Open
#530 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
53
Forks
57
Avg merge
1d 23h
Merged PRs (30d)
2

Description

I can't find any docs on how this tool should be installed or used. The README is extremely barebones, and the NPM homepage only contains some yaml samples of how this can be embedded in existing tool pipelines, without even naming those tools.

The closest guide I've seen is in a downstream project [here](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/ci-fix.md#lintdiff-validation), which at least shows how to invoke this tool via `autorest`. However it also says "Please see [readme](https://github.com/Azure/azure-openapi-validator/blob/main/README.md) for how to install or run tool in details", linking to this repo's README.md, which contains so such instructions.

There may be some instructions in the `docs/` folder? But I can't tell, as there's no `README.md` guide or intro doc there, and all of the files seem to be descriptions of specific linter rules.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.