Skip to content

Unify repository and website documentation #1407

Description

@jescalada

Currently, documentation is scattered across the repository (/docs) and website (/website/*.mdx). We should find a way to unify existing docs, perhaps by converting everything into repo docs, and then publishing those directly to the website so that both are identical.

Note that MDX allows for a few more text formatting options, so existing website docs might have to be simplified a bit when converting to vanilla Markdown.

Additional context
Related discussion: #1391

Should these docs move into /website/docs to keep it all in one place?
Also thinking about @andypols comments about separating docs in the website for end users and those configuring/deploying git proxy. The docs in this /docs folder are all useful to those deploying or upgrading, so perhaps we should take this oppurtunity to unite them and do that division?

Related issues: #1272, #1346, #1347

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions