Skip to content

Generate bundle READMEs from a template#859

Merged
shawnbot merged 2 commits intorelease-12.6.0from
generate-bundle-readmes
Aug 7, 2019
Merged

Generate bundle READMEs from a template#859
shawnbot merged 2 commits intorelease-12.6.0from
generate-bundle-readmes

Conversation

@shawnbot
Copy link
Contributor

@shawnbot shawnbot commented Aug 7, 2019

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:

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 to src/**/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!

@shawnbot shawnbot requested review from jonrohan and simurai August 7, 2019 22:21
@vercel
Copy link

vercel bot commented Aug 7, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Copy link
Member

@jonrohan jonrohan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh yeah, nice. ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants