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 README.md, add CONTRIBUTING.md, and more! #152

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

BD103
Copy link
Member

@BD103 BD103 commented Oct 17, 2024

Closes #109.

This PR:

  • Creates bevy_lint's README.md
  • Modifies the main CLI's README.md
  • Creates and moves some information into CONTRIBUTING.md
  • Adds README.md into bevy_cli's rustdoc output.
  • Sets up some custom CSS styles so Github alerts render nicely in rustdoc.

image
image

Todo

@BD103 BD103 added A-Linter Related to the linter and custom lints C-Docs An improvement in documentation labels Oct 17, 2024
@BD103 BD103 marked this pull request as ready for review October 18, 2024 03:29
@BD103
Copy link
Member Author

BD103 commented Oct 18, 2024

Unfortunately Github alerts are currently broken, but I'll take a look in the morning.

@BD103 BD103 changed the title Create README.md for bevy_lint Improve README.md, add CONTRIBUTING.md, and more! Oct 18, 2024
@BD103
Copy link
Member Author

BD103 commented Oct 18, 2024

So I tried using Github's alerts

Tip

like this

but they don't render correctly when wrappen in a <div>, turning into

[!CAUTION]

this :(

As such, I'm going to keep the pretty rustdoc alerts but replace Github's side

Note

With this. It's not nearly as nice, but I like it better than having no pretty alerts at all, or having rustdoc's plain block quotes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Linter Related to the linter and custom lints C-Docs An improvement in documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add installation instructions
1 participant