Add rustdoc + GitHub Pages deployment - #12
Merged
Conversation
- Create src/lib.rs exposing detector, scanner, known_tools as public API - Add [lib] section to Cargo.toml for library documentation - Refactor src/main.rs to import shared modules from aicheck:: - Add .github/workflows/docs.yml to auto-generate and deploy docs to GitHub Pages - Move translated READMEs (6 languages) to docs/ directory with updated cross-links - All tests pass (59 tests), docs build successfully with cargo doc --no-deps Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
src/lib.rsdocs/directory with updated cross-linksImplementation
src/lib.rswith crate-level docs and module re-exportsCargo.tomlwith[lib]sectionsrc/main.rsto import shared modules from theaicheck::library.github/workflows/docs.ymlfor automated docs build & deploy (requires GitHub Pages enabled in repo settings)docs/and updated all language switcher linksVerification
cargo build✓cargo doc --no-deps✓ (generates attarget/doc/aicheck/index.html)cargo test✓ (all 59 tests pass, including doc-test)Note: Enable GitHub Pages in repo settings (Settings > Pages > Source: GitHub Actions) to activate automatic deployment.
🤖 Generated with Claude Code