doc-warden 0.7.3

Doc-Warden is an internal project created by the Azure SDK Team. It is intended to be used by CI Builds to ensure that documentation standards are met. See readme for more details.

Stars: 129, Watchers: 129, Forks: 227, Open Issues: 1746

The Azure/azure-sdk-tools repo was created 7 years ago and the last code push was 48 minutes ago.
The project is popular with 129 github stars!

How to Install doc-warden

You can install doc-warden using pip

pip install doc-warden

or add it to a project with poetry

poetry add doc-warden

Package Details

Author

Microsoft Corporation

License

MIT License

Homepage

https://github.com/Azure/azure-sdk-tools/

PyPi:

https://pypi.org/project/doc-warden/

GitHub Repo:

https://github.com/Azure/azure-sdk-tools

Classifiers

Related Packages

Errors

A list of common doc-warden errors.

Code Examples

Here are some doc-warden code examples and snippets.

GitHub Issues

The doc-warden package has 1746 open issues on GitHub

• [Mgmt] ~30 specs are missing emitter configs — need clarification to improve our understanding
• Bump @typescript-eslint/eslint-plugin from 8.52.0 to 8.53.1 in /tools/sdk-testgen
• Bump the npm_and_yarn group across 12 directories with 2 updates
• [ja-api-parser] Property and property signature generator
• Add a PromptToToolMatchEvaluator to measure tool discoverability
• [APIView] Bug: Diff "Changes Only" mode incorrectly filters out added and modified lines
• Bump default doc-warden version
• ApiView showing diffs that don't exist
• [AVC] Guideline update ingestion pipeline
• [logging.ps1] Align escape chars with @actions/code
• Fix empty owners issue
• CLI command to mark package as released in release plan
• sync new doc for bot
• [Teams Bot] add a lro evaluation test case
• [Teams Bot] Evaluation for AI search knowledge and the reference

See more issues on GitHub