Skip to content

Consider splitting README into multiple docs #411

@NyakudyaA

Description

@NyakudyaA

Feature description

The readme has become quite long and will continue to grow, let's consider splitting it and keep the main features here and flesh out most of the doc using either

  • GitHub wiki,
  • Github pages
  • Mkdocs.

We could have the following structure

  • README.md
  • docs/guide.md (Basics & Advanced Features)
  • docs/best-practices.md

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions