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

Improving English translations & standardizing styles for various pages #19

Merged
merged 5 commits into from
Aug 30, 2023

Conversation

michaeljolley
Copy link
Contributor

Description

  1. Improved clarity of wording for native English speakers of the following pages:

In case it wasn't obvious with two PR's in two days, I'm working on the English docs overall to improve the clarity for native English speakers. As a part of this work, I'm also standardizing styles to follow documentation norms for OSS projects (i.e. consistent heading styles, sequentially ordered heading tags, etc.) Ideally, I'll add a style guide for future contributors and include GitHub PR templates. The layout of this PR is following the example in the CONTRIBUTING.md, but we can make this a better experience for contributors by including it by default as a template. I'll be adding issues for those tasks in the coming days if that's okay with you.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

@ghost
Copy link

ghost commented Aug 30, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

Copy link
Member

@rsaz rsaz left a comment

Choose a reason for hiding this comment

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

Excellent observations. Thank you for your continued contribution to standardization of our doc. Keep it up with the good work. 👍🏻

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