Skip to content

Split README to simple landing page and documentation #156

@nettle

Description

@nettle

Describe the task

We should split our long README.md into simple landing page and actually documentation.
Reason: README.md should be very simple (What it is, How to use, that's it).
For documentation I would suggest https://github.com/docsifyjs/docsify or similar

Scope

  1. Move current README.md to doc/README.md
  2. Create small main README.md with minimal information:
    • What it is
    • How to use
  3. Optionally add simple documentation rendering engine
    • One of the options: docsify
  4. Optionally add documentation publishing to CI
  5. Plan next for documentation development

Definition of Done

  • Simple README.md
  • Documentation under doc/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions