PRDoc

Aug 17, 2023
Follow

prdoc is a tool designed to help generating, checking and loading .prdoc files. .prdoc files are YAML files adhering to defined JSON schema and helping with code change documentation.

It allows structuring the documentation per project, checking contributions for adherence to the structure, validating the content, and generating better quality release notes.

It is used by the Polkadot-sdk repository.

1. Features

  • Generate Documentation: Automatically generate documentation files based on your project’s codebase.

  • Check Documentation: Validate existing documentation files against a predefined JSON schema to ensure consistency and correctness.

  • Load Documentation: Easily load and parse .prdoc files for use in your projects.

Install with cargo
cargo install prdoc

More on the project can be found on the GitHub repository.

polkadot substrate tooling documentation rust
Avatar
Wilfried Kopp aka. Chevdor
Building Blockchains & Decentralized Solutions

I build decentralized solutions and tooling to support them. I am developing Smart Contracts and dApps on Ethereum and developing tooling for Substrate (Polkadot & Kusama). I love Rust! I am using Docker extensively and above all I like efficiency. GPG Fingerprint 15AF C574 D3F9 F1C3 CCDD E31E 2DCE C4DC 506E 6475.

Related