-
juangirini authoredThis PR is a continuation of https://github.com/paritytech/polkadot-sdk/pull/2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp What has been done: - The content under `docs/*` (with the exception of `docs/mermaid`) has been moved to `docs/contributor/` - Developer Hub has been renamed to Polkadot SDK Docs, and the crate has been renamed from `developer-hub` to `polkadot-sdk-docs` - The content under `developer-hub/*` has been moved to `docs/sdk` --- Original PR https://github.com/paritytech/polkadot-sdk/pull/2565, it has been close due to too many rebase conflicts --------- Co-authored-by:
Serban Iorga <serban@parity.io> Co-authored-by:
Chevdor <chevdor@users.noreply.github.com> Co-authored-by:
Egor_P <egor@parity.io> Co-authored-by:
Bastian Köcher <git@kchr.de>
PRDoc
Intro
With the merge of PR #1946, a new method for
documenting changes has been introduced: prdoc. The prdoc repository
contains more documentation and tooling.
The current document describes how to quickly get started authoring PRDoc files.
Requirements
When creating a PR, the author needs to decides with the R0 label whether the change (PR) should
appear in the release notes or not.
Labelling a PR with R0 means that no PRDoc is required.
A PR without the R0 label does require a valid PRDoc file to be introduced in the PR.
PRDoc how-to
A .prdoc file is a YAML file with a defined structure (ie JSON Schema).
For significant changes, a .prdoc file is mandatory and the file must meet the following
requirements:
- file named
pr_NNNN.prdocwhereNNNNis the PR number. For convenience, those file can also contain a short description:pr_NNNN_foobar.prdoc. - located under the
prdocfolder of the repository - compliant with the JSON schema defined in
prdoc/schema_user.json
Those requirements can be fulfilled manually without any tooling but a text editor.
Tooling
Users might find the following helpers convenient:
- Setup VSCode to be aware of the prdoc schema: see using VSCode
- Using the
prdoccli to:- generate a
PRDocfile from a template defined in the Polkadot SDK repo simply providing a PR number - check the validity of one or more
PRDocfiles
- generate a
prdoc cli usage
The prdoc cli documentation can be found at https://github.com/paritytech/prdoc#prdoc
tldr:
prdoc generate <NNNN>prdoc check -n <NNNN>