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.

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

chore(docs): restructure and rewrite content in documentation and quality standards chapters #74

Merged
merged 9 commits into from
Jul 30, 2024

Conversation

BirgitBader
Copy link
Contributor

@BirgitBader BirgitBader commented Jul 17, 2024

Context

  • Closes issue 15
  • Removes accordions to better display the content hidden behind them.
  • Uses TOCs to access the different sub-sections.
  • Rewrites and trims documentation chapter.

To reviewers

  • Check if the restructuring helps to better digest and access the provided content.
  • Check if rewriting leads to optimization of the chapters.
  • Fix any typos or grammar you might find.
  • Add anything that you see missing.

@BirgitBader BirgitBader requested a review from cgebken July 17, 2024 05:34
@BirgitBader
Copy link
Contributor Author

@thake It would be great if you could review this :)

Copy link
Contributor

@thake thake left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the effort! Just some minor things. @cgebken made a very thorough review!

api-guidelines/global/core-principles/documentation.md Outdated Show resolved Hide resolved
api-guidelines/global/core-principles/documentation.md Outdated Show resolved Hide resolved
api-guidelines/global/core-principles/documentation.md Outdated Show resolved Hide resolved
api-guidelines/global/core-principles/documentation.md Outdated Show resolved Hide resolved
api-guidelines/global/core-principles/quality-standards.md Outdated Show resolved Hide resolved
@BirgitBader BirgitBader requested review from thake and cgebken July 23, 2024 08:38
@BirgitBader BirgitBader merged commit 15c925d into main Jul 30, 2024
1 check passed
@BirgitBader BirgitBader deleted the 15_unhide-content branch July 30, 2024 06:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants