search

sindresorhus / gulp-rev

Static asset revisioning by appending content hash to filenames: `unicorn.css` → `unicorn-d41d8cd98f.css`
MIT License
1.54k stars 217 forks source link

Improve documentation #170

Closed benbieler closed 8 years ago

benbieler commented 8 years ago

Resolves #159

What's new?

The documentation has been split up, and now is in a docs folder.

Reviewers: @sindresorhus, @tjsail33 @rajzshkr @bobthecow @ajaybc @lukeed @samarpanda

sindresorhus commented 8 years ago

A bit too split up IMHO.

license → licence.md

👎

benbieler commented 8 years ago

@sindresorhus, can I squash and merge?

shinnn commented 8 years ago

license → licence

Intentional?

benbieler commented 8 years ago

@shinnn yes, I personally like .md licences, but I reverted this, since sindre already pointed this out.

lukeed commented 8 years ago

He means the typo on "licence" 😝

sindresorhus commented 8 years ago

@benbieler re license, it's not markdown, so no need to add extension.

sindresorhus commented 8 years ago

The gettingstarted.md file can be removed as it's just a duplicate of what's in the readme. The docs/api/rev/rev.md file has too much directory nesting. Just make it docs/api.md. Too much nesting for many of the other files too.

benbieler commented 8 years ago

Sorry about the license typo, I speak UK english.

sindresorhus commented 8 years ago

@benbieler The following needs to be resolved:

benbieler commented 8 years ago

@sindresorhus I already have solved those issues.(^^ See commits above: license, and gettingstartedremoval). I think that an additional readme.md inside the docs folder can be quite usefull (If the user simply clicks on 'docs' ), but if you want it gone, it is gone ;)

sindresorhus commented 8 years ago

Not at far as I can see. Look at the diff :) license needs to be renamed back to license.md, and less nesting per https://github.com/sindresorhus/gulp-rev/pull/170#issuecomment-216019441.

sindresorhus commented 8 years ago

Closing for lack of response and updates.

benbieler commented 8 years ago

@sindresorhus I'm sorry for the inactivity. I had a lot to do regarding work. Would this be merged if I reopened this, and fixed the small issues?

benbieler commented 8 years ago

I got this request from multiple people, so I think this would be worth it ;) ...

sindresorhus commented 8 years ago

@benbieler Nah. In hindsight, I don't think it's enough of a benefit. If the readme had been huge it would have been worth it, but it's not very long, so I think it's easier to just have everything in one file :)

benbieler commented 8 years ago

@sindresorhus Ok. Fine.