Move out documentation from README.md

[andrykonchin]

Changes

• moved Dynamoid API documentation out from the README.md file into doc/ directory and divide into separate files
• cleaned up and restructured the README.md file itself
• set up publishing on GitHub Pages

mdBook static site generator is used (see https://rust-lang.github.io/mdBook/).

The static site isn't published yet but this screenshot illustrates how it will look like (with light theme)

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.05%. Comparing base (61ee54a) to head (119628e).
⚠️ Report is 91 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1014      +/-   ##
==========================================
+ Coverage   92.38%   93.05%   +0.67%     
==========================================
  Files          78       84       +6     
  Lines        4042     4448     +406     
==========================================
+ Hits         3734     4139     +405     
- Misses        308      309       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[andrykonchin]

@pboling

It would be great if you could take a look at the new README.md. I've made it as tiny as possible and moved out all the documentation into doc/ directory.

I am also wondering if you can advise me on choosing a static site generator for the guides. I am considering the following options:

• Docusaurus (https://docusaurus.io/)
• MkDocs (https://squidfunk.github.io/mkdocs-material/)
• mdBook (https://rust-lang.github.io/mdBook/)

and ended up using mdBook. It isn't a final decision so any suggestion is welcome!

[pboling]

Excellent improvement.

[pboling]

@andrykonchin I agree with the mdBook choice. Docusaurus relies on React which I avoid whenever I can. Material for MkDocs feels heavier than is warranted for Dynamoid. 💯

[andrykonchin]

Great, thank you!

[github-actions]

Package	Line Rate	Health
dynamoid	93%	➖
Summary	93% (4139 / 4448)	➖

Minimum allowed line rate is 90%