AppFlowy-IO / AppFlowy-Docs

Other
73 stars 91 forks source link

Structure, formatting, and readability fixes #121

Closed egp415 closed 1 year ago

egp415 commented 1 year ago

Removed complex mixing of bullets and ordered lists in favor of headings

Removed unrecessary ordered lists

Cleaned up formatting issues especially with directory structures

More detail should be added regarding transactions, particularly what is meant by "state refresh"

The testing section of best practices is weak, probably should refer to an external document specifically on test case writing methodology

I think for long file paths, it is best to use code blocks (multiline code blocks delimited with three backticks) as these are going to tend to run off screen

There's still a lot of inconsistent formatting, especially when inline code (single backticks) are used vs. bold

annieappflowy commented 1 year ago

@MayurSMahajan , I merged it