Skip to content

[FEAT] Unify/simplify readmes and docs #496

@ondrej-lukas

Description

@ondrej-lukas

Is your feature request related to a problem? Please describe.

Currently, there are three sources of information:

  1. GitHub repo README
  2. PyPi package readme
  3. Docs

Majority of information should be in the docs

Suggested solution

For readme and PyPi, simplify, shorten the information only to the absolutely minimal required (how to run, how to contribute, where to find more info -docs). All design decisions, params, etc. should be only in the docs

Alternatives considered

No response

Additional context

No response

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions