Split the README into a GitHub README and separate Mkdocs doc page #541
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
Previously, the README file was symlinked into our docs. This led to a problem where we could only write links that worked within one of the two systems. Docs links need to be relative to the symlink to render correctly, and GitHub README links need to be relative to the original file to work correctly.
mfisher87
changed the title
andypbarrett
approved these changes
Apr 26, 2024
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.
Supersedes #534 .
The problem is that GitHub and Mkdocs use different syntax and have a different root directory, so symlinking files from the root directory isn't working as we expect it to work.
📚 Documentation preview 📚: https://earthaccess--541.org.readthedocs.build/en/541/