Swirrl / drafter

A clojure service and a client to it for exposing data management operations to PMD
Other
0 stars 0 forks source link

README and documentation update #659

Closed rosado closed 1 year ago

rosado commented 1 year ago

This PR contains changes to update Drafter's README in line with recent changes in muttnik project.

Motivation

Documentation needed a bit of a refresh and better organisation. Additionally, the repo will be made public soon, and what drafter was not easy to grok from existing documentation.

Notes For reviewers

As with the muttnik documentation changes, this PR is supposed to be starting point for a discussion, so any feedback is welcome.

The main additions are:

Otherwise it's re-shuffling existing content and removing outdated/conflicting information wherever I spotted it.

Fixes #658

RickMoynihan commented 1 year ago

Thanks @rosado this looks like a big improvement. I've pushed a few changes and made some comments/suggestions - but generally I'm really happy with it.

🙇

scottlowe commented 1 year ago

I rebased against master to include the recent deploy / pack fix for the broken build. This PR is green again ✅

Let's get it merged?