docs: Fix 24 documentation audit findings#47
Merged
Conversation
Correct inaccuracies, fill gaps, and improve documentation quality across all project docs. Key fixes: - Align setup.sh model with runtime default (qwen2.5:14b) - Add missing html output format to README - Fix broken mkdocs architecture page (add pymdownx.snippets) - Add eval module to ARCHITECTURE.md and mkdocs nav - Add uv prerequisite and missing make targets to CONTRIBUTING.md - Add LLM prompt injection to SECURITY.md scope - Fix dynamic version claim and add missing features to CHANGELOG.md - Add specific contact info to CODE_OF_CONDUCT.md - Add mypy strict badge to README
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.
Summary
Comprehensive documentation audit identified and fixed 24 findings: 7 inaccuracies, 4 inconsistencies, and 13 improvement opportunities across all project docs.
The most impactful fix:
setup.shpulledllama3but the CLI defaulted toqwen2.5:14b, causing errors on first run for any new contributor following the docs.Changes
llama3→qwen2.5:14bto match_defaults.pyhtmlto output formats, fix tree structure, add mypy badge, document default model + resource requirements, add missingmaketargetsenrichment.pydescription, addeval_command,eval_ragas,_json_utilsto supporting modules table, refine strict mode claimuvprerequisite, fix model reference, addmake typecheck/check/test-all/docs, add 3 missing eval test suites, fix eval fixture schema fieldspymdownx.snippetsextension (fixes brokendocs/architecture.md), add eval API reference to naveval_commandTest Plan
uv run pytest)uv run ruff check .)uv run mypy src/)Checklist