search

crate / crate-docs

Common build system, QA tools, style guides, and other meta miscellanies for doing docs at Crate.io.
Apache License 2.0
2 stars 1 forks source link

Build system overhaul #61

Closed nomicode closed 3 years ago

nomicode commented 3 years ago

I started this pull request to close https://github.com/crate/crate-docs/issues/60 (which it does) but while working on refactoring the Vale globs so Git could use them (Don't Repeat Yourself) I spotted a couple of bugs and a whole bunch of opportunities for improving the build system

this PR has been through multiple iterations. but I think this is finally ready for review. the details of the changes can be found in the commit message

we have a lot of unreleased changes now. after this PR is merged, I suggest that we cut a new release. given the change to docs/Makefile (which requires downstream projects to alter their setup slightly), I suggest we release 1.0

amotl commented 3 years ago

Thank you! I will add some minor comments.

nomicode commented 3 years ago

@amotl I pushed the changes I've been working on. finally got everything to work

unfortunately, I spent the best part of an hour writing a (new) detailed commit message, and then I guess I did something wrong, and Git promptly threw and tantrum and "lost" my commit message. I will re-write the commit message tomorrow when I'm feeling less demoralized 😔

I recommend you hold off reviewing until then

amotl commented 3 years ago

👍

nomicode commented 3 years ago

@amotl this is ready for review! 🙌

nomicode commented 3 years ago

@amotl I recommend you check this branch out and play around with it 😎

image

nomicode commented 3 years ago

added a fix for https://github.com/crate/crate-docs/issues/21 as a bonus 💅

amotl commented 3 years ago

Thank you very much for your efforts Naomi. Please integrate your patch and I will give it a try on one of the next iterations when working on the documentation of some project.