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.

Sign up for GitHub

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

Jump to bottom

Write README.md for bevy_lint #109

Closed
BD103 opened this issue Sep 25, 2024 · 2 comments · Fixed by #170
Closed

Write README.md for bevy_lint #109

BD103 opened this issue Sep 25, 2024 · 2 comments · Fixed by #170
Labels
A-Cross-Cutting Affects multiple areas of the repository C-Docs An improvement in documentation
Milestone
`bevy_lint` 0.1.0

Comments

@BD103
Copy link
Member

BD103 commented Sep 25, 2024 •
edited
Loading

We need installation instructions for both the CI itself and the linter. For now we should just target compiling from the Git repository, since we don't have any releases yet.

On the linter side it will need to cover:

  • Installing the correct nightly version and components
  • Installing the linter itself
  • How to use #![register_tool(bevy)] and configure lints to be behind a cfg variable

I started this in #152, feel free to build off of that!
@BD103 BD103 added C-Docs An improvement in documentation A-Cross-Cutting Affects multiple areas of the repository labels Sep 25, 2024
@BD103 BD103 added this to the `bevy_lint` 0.1.0 milestone Sep 27, 2024
@BD103 BD103 mentioned this issue Sep 28, 2024
Closed
@BD103
Copy link
Member Author

BD103 commented Sep 28, 2024

#117 will need to be implemented before this, since we want to document the --cfg bevy_lint behavior.

@BD103 BD103 mentioned this issue Oct 17, 2024
Closed
3 tasks
@BD103 BD103 changed the title Add installation instructions Write README.md for bevy_lint Oct 21, 2024
@BD103
Copy link
Member Author

BD103 commented Oct 21, 2024

The README.md should also have:

  • A compatibility table with supported Rust version, Rustup toolchain, and Bevy version
  • Note on how this project is still unofficial and unstable
  • How to use bevy_lint to check a project
  • How to configure lints, along with a table showing what methods are supported
  • License and contributing notes

@BD103 BD103 mentioned this issue Oct 21, 2024
Merged
@BD103 BD103 mentioned this issue Oct 31, 2024
Merged
BD103 added a commit that referenced this issue Oct 31, 2024
@BD103
Clarify release.md and add compatibility table (#166)
ff50477 
Closes #165, begins tackling #109.

This PR makes some small improvements to `release.md` based on @MrGVSV's
comments. It also adds a minimal `README.md` with the compatibility
table.

This `README.md` is not in its the final form, and it will be
significantly improved once #109 and #161 are done.
BD103 added a commit that referenced this issue Nov 6, 2024
@BD103
Add CSS for rustdoc alerts (#161)
2480d60 
Closes #158, extracted from #152, will be used in #109.

This adds pretty alerts in `rustdoc` for `bevy_lint` that will be used
in #109 when writing `bevy_lint`'s user documentation.

<img width="908" alt="alerts in light mode"
src="https://github.com/user-attachments/assets/4ee666f2-bb85-40de-b0f6-19b7a19a45e9">

<img width="908" alt="alerts in dark mode"
src="https://github.com/user-attachments/assets/67ce7308-175c-4673-9c1e-7f89c59c4c73">

<img width="908" alt="alerts in dark mode, with the ayu theme"
src="https://github.com/user-attachments/assets/e2de4717-bc63-4d1d-bb88-83714b3cf530">
@BD103 BD103 mentioned this issue Nov 7, 2024
Merged
@BD103 BD103 closed this as completed in #170 Nov 9, 2024
@BD103 BD103 closed this as completed in ff952b2 Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Cross-Cutting Affects multiple areas of the repository C-Docs An improvement in documentation
Projects
None yet
Milestone
`bevy_lint` 0.1.0
1 participant
@BD103