README rewrite - Githubissues

ebowman / api-first-hand

API-First bootstrapping tool for building RESTful web services from a Swagger/OpenAPI spec

MIT License

142 stars 22 forks source link

README rewrite #70

Closed LappleApple closed 7 years ago

LappleApple commented 7 years ago

Hey,

The README is significantly shorter; I updated the files in the /docs folder, and also created several new ones to transfer some of the original README documentation into discrete files. These new files are linked-to from this README.

I still need some guidance on the "architecture and structure" section toward the bottom as I think it's not 100% there yet.

LappleApple commented 7 years ago

Hi @slavaschmidt, if that's because you're the only person who knows, then sure thing. But as a way to start distributing the effort past "bottleneck of one dedicated person", can you @stuartmclean also read and review to ensure it makes sense? Also I see @s12v has taken a look; another pass would be +1. @gipeshka, by all means you too please give a look and note anything that seems wrong or is confusing. Same to @alexkops.

If readability and accuracy are our goals, then multiple points of view are +1.

LappleApple commented 7 years ago

@slavaschmidt Hi, do you know when you'll review this?

slavaschmidt commented 7 years ago

Hey Lauri,

great work splitting it apart! Sorry it took me so long to go through it. I haven't deeply check other files in the doc folder as I expect them to be mostly copy-pasted from the previous README, right?

Two remarks still:

The enum part will be implemented completely differently in the next version for couple of technical reasons, this is related to the DEFINITIONS.md
It might make sense to rename swagger-validations.md to SWAGGER_VALIDATIONS.md for consistency

Hell, as I read the new version of the README, my hands are almost itching to develop something in this repo 👍