docs: add generated OpenWiki code documentation - #56
Open
ngadminq wants to merge 2 commits into
Open
Conversation
ngadminq
marked this pull request as ready for review
August 14, 2026 08:33
weiwill88
requested changes
Aug 16, 2026
weiwill88
left a comment
Owner
There was a problem hiding this comment.
Thanks for the contribution. I am requesting changes before this generated documentation can be merged.
The current PR adds 24 Markdown files and 5,815 lines, but the generated output is not yet review-ready:
- The PR description is still the unfilled template, and none of the validation items are checked.
- The
openwiki/tree contains 76openwiki: broken internal linkdiagnostics. Many links start at the repository root (for example,/core/...) even though the targets live underopenwiki/. openwiki/architecture/overview.mdstill contains a Mermaid parse-failure diagnostic and renders the architecture diagram as a text block.openwiki/configuration/environment-and-models.mddocuments the configuration precedence incorrectly.load_dotenv()usesoverride=Falseby default, so an existing process environment value wins over the dotenv file; the code also chooses either.envorexample.env, rather than loading both as successive priority layers.- The hard-coded coverage estimates in
openwiki/testing/overview.mdare not reproducible and disagree with the current test run. Generated documentation should not publish approximate coverage figures unless they are produced from CI artifacts. - The PR does not explain how this large generated documentation set will be regenerated, validated, or kept synchronized with source changes. Passing the existing Python tests does not validate Markdown links, diagrams, or factual accuracy.
Please address the following before requesting another review:
- Remove all generator diagnostic comments and make the internal links and Mermaid diagrams pass validation.
- Correct source-grounded statements and remove or automatically generate unstable metrics such as coverage.
- Document the regeneration command/tool version and the expected maintainer workflow.
- Complete the PR description and validation checklist.
- Squash the generated revisions into a clean update after validation.
I am leaving the PR open so it can be revised.
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 changed
Describe the focused change and the part of the RAG pipeline it affects.
Why
Explain the bug, learning need, maintenance requirement, or user impact.
Validation
python -m compileall -q api_router.py config.py rag_demo.py version.py core features utils testsPYTEST_DISABLE_PLUGIN_AUTOLOAD=1 python -m pytestRelated issues
Closes #