Skip to content

[META] user focused and developer focused documentation must be separated #1214

@jacobcook1995

Description

@jacobcook1995

At the moment the documentation, very much merges documentation aimed at developers with documentation aimed at users. This is a major issue as it pushes users towards things that they shouldn't really have to do (e.g. installing via poetry)

Broadly what needs to happen is for the relevant sections to be reviewed and condensed into the user focused documentation. Some of the content should probably be moved to be reference documentation. The rest of it is more "how-to"s aimed at developers, which should be moved into a new section (that have some "proceed at your own risk" signposting).

We don't want to lose any content and we might as well verify that the content is still up to date, but the developer documentation is not currently a priority, so we are really looking to build somewhere to park the information rather than significantly improve the flow or content.

There's a bunch of smaller issues about how the different sections are presented to users that I am also going to group under this issue.

Sub-issues

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