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

Documentation style guide update #1215

Merged
merged 7 commits into from
Jan 9, 2025
Merged

Documentation style guide update #1215

merged 7 commits into from
Jan 9, 2025

Conversation

TinaKT
Copy link
Contributor

@TinaKT TinaKT commented Jan 9, 2025

Purpose

To update the existing style guide and include tone of voice guidelines as well.

Changes

The guide is now a document that can be placed on the developer documentation web site under Docs/Help & FAQ/FAQs

It includes information about:

  • Documentation types (in accordance with the Divio system)
  • Tone of voice and language
  • Formatting
  • A review checklist to help maintain documentation quality and reduce the risk of common issues

TODO: Update the README of the documentation to reflect the changes - either by including them or to skip them in the latest version or by deleting them from the README.

Checklist

  • My code follows the style of this project.
  • The code compiles without warnings.
  • I have performed a self-review of the changes.
  • I have documented my code, in particular the intent of the
    hard-to-understand areas.

By submitting the contribution I accept the terms and conditions of the
Contributor License Agreement v1.0

@TinaKT TinaKT requested a review from dragosgd January 9, 2025 11:59
Copy link
Contributor

@dragosgd dragosgd left a comment

Choose a reason for hiding this comment

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

LGTM

@TinaKT TinaKT merged commit 86b77cc into main Jan 9, 2025
2 checks passed
@TinaKT TinaKT deleted the style-guide-update branch January 9, 2025 13:51
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.

2 participants