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

Improve clarity and structure in editorial style guide #29

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jhonceth
Copy link

@jhonceth jhonceth commented Aug 7, 2024

This PR proposes improvements to the editorial style guide by:

  • Clarifying the use of technical terms
  • Structuring the writing guidelines into clear sections (Vision and Mission, Progress and Future Plans, Concrete Examples)
  • Enhancing tone and voice guidelines with examples for different contexts
  • Improving clarity and concision
  • Ensuring consistency in formatting (use of em dash, Oxford comma)
  • Adding a glossary for commonly used terms

These changes aim to make the document more user-friendly and easier to navigate.

@cb-heimdall
Copy link
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

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