Move documentation website into separate folder #343
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
i-like-robots
added
documentation
i-like-robots
requested review from
benbarnett,
apaleslimghost,
debugwand,
robsquires and
fenglish
apaleslimghost
previously approved these changes
Jul 10, 2019
i-like-robots
force-pushed
the
matth/move-x-docs
branch
from
d8aba87 to
60e3c42
Compare
rowanbeentje
pushed a commit
that referenced
this pull request
Nov 24, 2021
Move documentation website into separate folder
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is intended to help resolve some of the issues raised in #340, #274, and #177 by moving the documentation website into its own top-level folder with its own install and build scripts.
Installing and building the documentation website is slow, it increases the initial project install and build times by approximately 40-50%. However because using the docs website is not a day-to-day part of the workflow when building x-dash components this has caused a lot of wasted time and battery power. This wasted time and energy is the most common gripe that I hear from developers working with x-dash.
On my (home) machine this change decreases the total time from fresh clone to ready to go from ~3 mins to ~1 minute.
With this change the documentation website will no longer be installed and built by default (i.e. when running
make install build) or included in tasks run using Athloi. Instead, using the docs site can be done using the following commands:This change also ensures the documentation website will only be installed and built on CI when required rather than on every branch build, hopefully saving further time and energy.
Initially Bren and I wanted the docs website to be a core part of the x-dash workflow but it's not turned out this way. It's clearly an area that needs to be revisited and revised. By putting it to one side I hope we can immediately decrease some friction working with x-dash.
Please let me know what you think!