Skip to content

Project Documentation Standards #151

@franziskuskiefer

Description

@franziskuskiefer

What's the documentation all projects should provide? We should aim at least for the Readme.md of all projects to have a similar structure and there should be a common set of information to be found on all of them.

Here's a rough idea of what that could go on there

  • getting started
  • status
  • security
  • Verification status label
  • Verification status table (with common column names across all projects)
  • Performance (common layout across all projects, with comparable numbers)
  • FAQ

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions