Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate bundle READMEs from a template #859

Merged
merged 2 commits into from
Aug 7, 2019

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!

@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