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

revise and proofread project documentation #2960

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

Conversation

wackbyte
Copy link

  • README.md:
    • Edit for grammar and clarity.
  • CONTRIBUTING.md:
    • Edit as above.
    • Remove unnecessary horizontal rules.
    • Move the shared "commit guideline" section up to reduce duplicated content.
    • Format repository/project structure blocks as lists rather than code. I think this is more accessible and easier to read.
    • Use GitHub Markdown's "alert" feature.
  • docs/:
    • Edit as above.
    • Replace HTML <hr> with Markdown --- and remove unnecessary ones.
    • Remove some extraneous <br>.
  • etc.

This PR is not exhaustive. I may do more work in a follow-up PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants