Generate bundle READMEs from a template #859
Merged
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 is a lazy (yet innovative!) way of keeping the
src/**/README.md
files up to date. I started trying to address the inconsistencies manually in #858, but quickly found that to be a waste of time. Here's the deal:{bundle}
placeholders.README.md
for eachindex.scss
in thesrc
directory, and replaces the{bundle}
placeholder with the directory name. See src/alerts/README.md as an example of the generated output.If I'm out of town when y'all get around to reviewing this and the template needs tweaking, please go ahead and edit it on this branch and re-run
script/generate-bundle-readmes
locally, then push your changes tosrc/**/README.md
.@colebemis: the README files in our
src
directory are not included on the docs site, so you shouldn't need to worry about this!