Try symlinking from docs to externals (changelog, hardware assets) #531
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 attempts to fix a DX complexity problem with editing the docs (as reported to me by @tcebron in a Slack DM conversation), in which Python is required for previewing docs in the editor due to the need for Python to copy in the software changelog (from
/software/CHANGELOG.md) and hardware assets (from/hardware) into the MkDocs documentation directory tree. This PR attempts to simplify things by instead symlinking to those external assets from within the MkDocs directory tree.