Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

☂️ Formalize Pallet and Call docs #13299

@ggwpez

Description

@ggwpez

The FRAME team realized that Pallet and pallet Call documentation should be more formalized and probably have some templates to them.
Ultimately this can be CI checked by parsing the docs with a macro and comparing against the templates.
This should help to have a unified basis to build higher-level docs upon

First step would be to agree on a structure for the pallet level docs and README requirements for them.

(cc @lisa-parity in case you have some ideas)

Metadata

Metadata

Assignees

No one assigned

    Labels

    I6-documentationDocumentation needs fixing, improving or augmenting.U3-nice_to_haveIssue is worth doing eventually.Z3-substantialCan be fixed by an experienced coder with a working knowledge of the codebase.

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions