docs(docz): rewrite readme - Githubissues

doczjs / docz

✍ It has never been so easy to document your things!

https://docz.site

MIT License

23.55k stars 1.46k forks source link

docs(docz): rewrite readme #1656

Closed HonkingGoose closed 2 years ago

HonkingGoose commented 2 years ago

Description

Use GitHub's built-in table of contents (TOC)
Rewrite many sentences for clarity
Use active voice where possible
Fix spacing of : after list items
Create separate section for the create-docz-app
Use monospaced font for some filenames

Review

[ ] Check the GitHub rich diff preview of the Markdown file
[ ] Check my wording, confirm you agree with the changes

Pre-merge checklist

[ ] Get reviewed

Screenshots

Use the GitHub preview of the PR to see the differences.