docs(security): add public docs folder with security overview#644
Merged
docs(security): add public docs folder with security overview#644
Conversation
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
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.
What
Adds a top-level
docs/folder for public-facing documentation, starting with a security overview article.Why
Bashkit has extensive internal security documentation (specs, threat model, rustdoc guides) but no user-facing summary. This gives users a single entry point to understand the security model.
How
docs/security.md: High-level security article covering:AGENTS.md: Updated Documentation section to distinguishdocs/(public) fromcrates/bashkit/docs/(rustdoc)Tests
Docs-only change. All 2000+ existing tests pass. fmt and clippy clean.