Skip to content

Improve doc building process #649

Open
@ianthomas23

Description

@ianthomas23

When you build the docs locally or via CI, it rebuilds many old versions of the docs as well as the current ones. This isn't ideal as it takes a long time to do so, and uploading to the doc site uses a lot of bandwidth. Also, we should not recreate and upload old versions of the docs, they should remain as they were when released - the rebuilding may be using different versions of dependencies that causes the output to render differently.

So the proposal is to change the doc build system to only build a specific version (e.g. the latest tagged release, or current git HEAD). The hosting situation for the docs, and the automatic upload system also need to be considered so that they all continue to work together.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

Status

📋 Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions