rebus-ink / ink-API

Hobb API Server: backend for the Rebus Reader system
GNU Affero General Public License v3.0
4 stars 5 forks source link

Refactor README, introduce development guide #698

Closed nicholasjhenry closed 2 years ago

nicholasjhenry commented 2 years ago

This is the first PR in a series to improve documentation and the onboarding experience for new developers.

No information was lost from the original README in this documentation revision, just extracted to other files and reformatted.

NOTE: the development guide does not cover running the server locally to develop with ink-library. This will come later in another PR. This only gets a successful test environment running.

nicholasjhenry commented 2 years ago

@Marie000 Do think you will have time to look at this today, please?

nicholasjhenry commented 2 years ago

@Marie000 Is this good to merge?

nicholasjhenry commented 2 years ago

@Marie000 any update on this?