Contribution Documentation

[CallumWalley]

A place to discuss organising our contributor documentation.

FORMAT.md

• Examples of markdown formatting
• limited demonstration of macros.
• Some prescriptive content (e.g. style guide).

CONTRIBUTING.md

• Walkthrough of pull request though github.
• How to setup local development environment.
• How to setup codespaces.
• VSCode Features usage.
• How to see checks.
• Raise an issue: TODO
• Generic overview of PR
• Description of how to contribute to some advanced features (supported apps page, wordlist).

NEWPAGE.md

• Detailed walkthrough creating page in github.
• Detailed walkthrough creating page in code.
• Full description of how to order and rename sections and pages.
• Some prescriptive content.
• Full description of different meta parameters.
• Link to accessibility standards. (essentially a TODO)

MACROS.md

• Technical

CHECKS

• Technical

WORKFLOWS

• Technical

[CallumWalley]

Improvements I can think of for the moment.

FORMAT.md

• Should be more prescriptive.

CONTRIBUTING.md

• Describe creating an issue.
• Move some of the more advanced content elsewhere.
• Move some of the 'setup' content elsewhere.
• Should be 'landing page' for contributors, lots of links.
• Clarify/consolidate PR content.

NEWPAGE.md

• Move the detailed descriptions elsewhere.

[CallumWalley]

Would also be useful to add some content around page lifecycle management. Could automate detection of stale content.