Documentation Reviewers

atk4 / data

Data Access PHP Framework for SQL & high-latency databases

https://atk4-data.readthedocs.io

MIT License

273 stars 46 forks source link

Documentation Reviewers #23

Closed romaninsh closed 8 years ago

romaninsh commented 8 years ago

We need people who will read documentation, make sure it's properly cross-linked, fix language, make sure examples look consistent and that documentation overall is easy to read.

Out of date documents:

[ ] http://agile-data.readthedocs.io/en/latest/quickstart.html?highlight=action - rewrite
[ ] https://github.com/atk4/data/wiki - remove irrelevancies

Review clarity:

[ ] http://agile-data.readthedocs.io/en/latest/model.html is this doc clear?
[ ] more docs after we merge PRs!

romaninsh commented 8 years ago

I have updated

To make them up-to-date and have valid working examples. I haven't checked the examples fully yet, but technically they should work.

I'll update the main ticket description to list the documents that need some love.

romaninsh commented 8 years ago

The main sections have been reviewed by @skondakov, so I'm sufficiently happy to close this one for now. If any documentation is missing, create a separate issue.