Adds comprehensive project documentation structure#77
Merged
Conversation
Introduces a complete documentation suite to improve codebase navigation and onboarding for contributors and users. Creates an IKL (project map) as the main entry point for documentation, providing quick navigation to code modules, common tasks, and key symbols. Adds architecture documentation covering system design, data flows, and component boundaries with detailed pipeline diagrams. Documents design decisions with rationale for logic hash deduplication, three-tier packaging, private rule handling, and scoring systems. Includes a glossary defining YARA and project-specific terminology. Adds module-specific documentation for CLI, main processing modules, and QA components with function references and configuration surfaces. Updates README with clearer project description focused on use cases and weekly release automation. Adds Claude settings to gitignore. Improves discoverability for security teams integrating YARA Forge into their workflows and reduces time-to-contribution for new developers.
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.
No description provided.