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

[Docs] README.md updates #2265

Open
9 tasks
VaclavElias opened this issue May 21, 2024 · 0 comments
Open
9 tasks

[Docs] README.md updates #2265

VaclavElias opened this issue May 21, 2024 · 0 comments
Assignees
Labels
area-Doc Issues related to documentation

Comments

@VaclavElias
Copy link
Contributor

Describe the update or improvement you would like to see

  • Center the logo to the center
    • Add a link to Stride website
  • Remove Code of Conduct section (it is in the separate file, linked from the README.md meta)
  • Move License and governance to the bottom
  • Update Documentation section, include emojis for consistency
  • Review Building from source section
    • Test Prerequisites
    • Test Build Stride
  • Improve other sections and readability

Is this related to a specific part of the documentation?
README.md

Why is this update needed?
Readability improvements

Additional context
We can further review the updates once the draft is ready

Proposed changes
Listed above.

@VaclavElias VaclavElias added the area-Doc Issues related to documentation label May 21, 2024
@VaclavElias VaclavElias self-assigned this May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Doc Issues related to documentation
Projects
None yet
Development

No branches or pull requests

1 participant