reconciliation-api / specs

Specifications of the reconciliation API
https://reconciliation-api.github.io/specs/draft/
30 stars 9 forks source link

Can we update README now that existing state of API documentation is completed? #159

Closed thadguidry closed 3 months ago

thadguidry commented 3 months ago

In README currently

Initially, the aim is to document the existing state of the API, as witnessed by the existing clients and servers, and the original documentation on OpenRefine's wiki. Once the existing API is documented to a satisfactory level, we will incorporate improvements discussed in the Community Group in further versions of the document.

That seems like we should probably rephase this or remove that long paragraph completely and for provenance maybe only put a note about original api documentation link someplace far below at the end of the README...or not worry about provenance in the README at all perhaps since we already fully documented the history with links in the first sections of the index.html file in the repo?