fixing typos and other style-issues in documentation-files

camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs

Apache License 2.0

9 stars 24 forks source link

fixing typos and other style-issues in documentation-files #232

Closed maxl2287 closed 5 days ago

maxl2287 commented 3 weeks ago

Problem description Currently the documentation-files, e.g., API-design-guideline.md has some broken internal references (e.g., inside the table of content). Also some other issues were found like:

unformated tables
too long sentences, which were hardly to read on the first try.
missing articles
some grammar issues