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 aims to improve our introduction and README sections with the following changes:
README.md
anddocs/content/introduction.md
now have the same content.README.md
Currently README and introduction are maintained separately. I couldn't figure out a way to have them read the same source; GitHub MD has no include functionality, and hugo cannot read files outside of it's root directory (/docs
).They also use different link syntax (hugo uses<ref >
shorttags) making them a little incompatible.Maybe we could lint for this? It's always going to be a bit fuzzy though. Otherwise some compile step that writes both files from a single source?Of course, git can track links. With this we are able to link
README.md
into the hugo content dir and munge it's contents there.