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

Improve overview section of readme. #362

Closed
Garbee opened this issue Aug 18, 2014 · 11 comments
Closed

Improve overview section of readme. #362

Garbee opened this issue Aug 18, 2014 · 11 comments

Comments

@Garbee
Copy link
Contributor

Garbee commented Aug 18, 2014

From the discussion on feedback in Issue #361 I found the current overview in the readme to be bland and slightly unclear. A good step to solving developer confusion or unease about the project would be to improve this critical section.

Based on this comment I am thinking something like this would be a better overview. The final update however is dependent up on the rest of the discussion in issue #361 since that could change how things are approached.

Overview

Web Starter Kit is an opinionated boilerplate for web development. Tooling for building an experience that works great across multiple devices and is performance oriented. We help you stay productive and aligned with the best practices outlined in Google's Web Fundamentals. A solid starting point for both professionals and newcomers to the industry.

@Garbee Garbee mentioned this issue Aug 18, 2014
@addyosmani
Copy link
Contributor

Thanks for kicking off a rethink of the current overview, @Garbee. This is solid. It checks off the multi-device focus, performance and manages to be more general in the opening line.

cc @PaulKinlan & @petele for any further thoughts on improvements we can make to the copy here.

@Garbee
Copy link
Contributor Author

Garbee commented Aug 18, 2014

Going over some old reddit threads myself, I notice a lot of 'how does it compare to bootstrap?' posts. We should really find a good way to address the fact that (at least currently, and looking at the discussion in the main thread it looks to stay that way) that WSK is not a direct competitor to full frameworks.

EDIT: duh, great place to address this is the FAQ. And going there to check, of it is already done so this should get floated somehow in the main readme while not being a direct part of the overview.

@addyosmani
Copy link
Contributor

I wonder if we should just flat-out include the text from that portion of the FAQs in the readme as a start. I'm also wondering whether it's worth investing a small amount of time in showing developers how (if they needed to) they could say, add in something like Bootstrap to WSK. Ideally however they should just straight up be using their own styles.

@addyosmani addyosmani mentioned this issue Aug 18, 2014
7 tasks
@Garbee
Copy link
Contributor Author

Garbee commented Aug 18, 2014

Adding a doc section on integrating a framework like Bootstrap would be a good step. I assume that developers could see that, then realize they don't need to chose WSK or Bootstrap/insert framework here. They can work together and overall without too much effort. You don't lose frameworks by choosing to use WSK, you gain a good base for workflow/tools that you can add them into.

addyosmani added a commit that referenced this issue Aug 18, 2014
This change adds a revised section on WSK vs CSS libraries based on
some content I wrote for the FAQs. I’ve run it through hemmingwayapp,
but if anyone has further feedback I’m happy to tackle this further.
addyosmani added a commit that referenced this issue Aug 18, 2014
For #362 - adds section on WSK & CSS libraries.
@Garbee
Copy link
Contributor Author

Garbee commented Aug 18, 2014

Something just hit me...

We help you stay productive and aligned

Should the use of "we" also be avoided in the documentation for this project as is done in the Chrome DevTool Docs?

@addyosmani
Copy link
Contributor

Web Starter Kit helps you stay productive and aligned would be the alternative?

@Garbee
Copy link
Contributor Author

Garbee commented Aug 18, 2014

That or just:

Helping you to stay productive....

Let me run these through hemmingwayapp and see if it complains at all about either. I'd personally prefer this version since it reduces the number of times the name of WSK is mentioned. It should be the object of reference throughout the entire paragraph.

@Garbee
Copy link
Contributor Author

Garbee commented Aug 18, 2014

Each of these methods creates a hard to read sentence (along with the tooling sentence.) I'll work on a cleaner copy and follow-up when it is ready.

@Garbee
Copy link
Contributor Author

Garbee commented Aug 18, 2014

Web Starter Kit is an opinionated boilerplate for web development. Tools for building a great experience across many devices and performance oriented. Helping you to stay productive following the best practices outlined in Google's Web Fundamentals. A solid starting point for both professionals and newcomers to the industry.

Missing links in this copy, but no issues in Hemmingway.

@addyosmani
Copy link
Contributor

Awesome. Want to submit a PR when you're ready? (alternatively I can directly edit)

@Garbee
Copy link
Contributor Author

Garbee commented Aug 18, 2014

Sure thing, I'll PR this in about 40 seconds.

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

No branches or pull requests

2 participants