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

Publish bevy_lint docs to Github Pages #155

Open
BD103 opened this issue Oct 21, 2024 · 0 comments · May be fixed by #160
Open

Publish bevy_lint docs to Github Pages #155

BD103 opened this issue Oct 21, 2024 · 0 comments · May be fixed by #160
Labels
A-CI Related to CI and GitHub Actions A-Linter Related to the linter and custom lints C-Docs An improvement in documentation

Comments

@BD103
Copy link
Member

BD103 commented Oct 21, 2024

bevy_lint's official lint documentation is built using rustdoc. Normally we'd be able to use https://docs.rs for host these docs, but it is unclear whether we will be able to publish to https://crates.io (see #150).

In the meantime, we should use Github Pages to host our unstable docs at https://thebevyflock.github.io/bevy_cli/bevy_lint.

I originally set up something for this in #152, so you should be able to copy the changes from there! (Anything changed within the .github/workflows folder.)

@BD103 BD103 added A-CI Related to CI and GitHub Actions A-Linter Related to the linter and custom lints C-Docs An improvement in documentation labels Oct 21, 2024
@BD103 BD103 added this to the `bevy_lint` 0.1.0 milestone Oct 21, 2024
@BD103 BD103 linked a pull request Oct 21, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-CI Related to CI and GitHub Actions A-Linter Related to the linter and custom lints C-Docs An improvement in documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant