Skip to content

Merge documentation #41

@MaximilianAlgehed

Description

@MaximilianAlgehed

Currently we have two .md documents that have significant overlap with two slightly different goals:

  • Manual.md which aims to give users a smooth introduction to using the system
  • DesignPrinciples.md which aims to explain how the internals work

I think it would be worth while to merge these two into one document that starts off explaining how to use the system and transitions into explaining how it works, clearly marking what a user needs to know and what a maintainer needs to know. That way we could more easily maintain the document and it would be natural to progressively reveal more internals to users as they become more comfortable with the system.

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