feat: README consistency updates for blues.dev parsing #161
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
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.
Problem Context
We are planning on ingesting the READMEs in this repo directly into the blues.dev documentation, and doing so is way easier if these READMEs are consistent for simpler parsing.
Changes
This PR makes several changes for consistency:
imagesorassetsfolder within the project. This makes it easier for us to rework the relative URL into one that will work when rendered on blues.dev.<p>or<img>tags. Non-Markdown elements are much harder to parse.Any other related PRs
https://github.com/blues/blues.dev/pull/1442
Ticket(s)
https://trello.com/c/ZqHmDvOe/511-accelerators-embed-full-project-instructions-from-github