Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
maxl2287 opened this issue Jun 11, 2024 · 0 comments · Fixed by #229 or #234
Closed

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

maxl2287 opened this issue Jun 11, 2024 · 0 comments · Fixed by #229 or #234
Labels
correction correction in documentation

Comments

@maxl2287
Copy link
Contributor

maxl2287 commented Jun 11, 2024 •
edited
Loading

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
@maxl2287 maxl2287 added the correction correction in documentation label Jun 11, 2024
@maxl2287 maxl2287 mentioned this issue Jun 11, 2024
Merged
@maxl2287 maxl2287 changed the title [API-Design-Guidelines]: fixing typos and other style-issues fixing typos and other style-issues Jun 11, 2024
@maxl2287 maxl2287 mentioned this issue Jun 11, 2024
Merged
@maxl2287 maxl2287 changed the title fixing typos and other style-issues fixing typos and other style-issues in documentation-files Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
correction correction in documentation
Projects
None yet
Milestone
No milestone
1 participant
@maxl2287