Repository navigation
docs: audit and align all documentation to actual Python/FastAPI code… - #1
Merged
Merged
Conversation
…base The original planning docs described a C# ASP.NET Core + Python Flask dual-runtime architecture that was never implemented. The actual codebase is a single-process Python FastAPI application. Updated six documents to accurately reflect the implementation: - 03_functional_requirements: FR-ING-04 — embedding is in-process, not a Python worker subprocess - 04_system_requirements: replace entire C# backend section with Python/ FastAPI stack; remove .NET SDK prerequisite; fix performance attribution (PyMuPDF not PdfPig); update security/privacy and architecture constraints - 05_architecture: full rewrite — single-process FastAPI diagram; updated data-flow pipelines (no C#→Python HTTP calls); correct component table referencing actual source files; add missing /text-positions endpoint; remove non-existent Python worker API section and IPC bridge section - 06_scope_and_milestones: fix in-scope tech (PyMuPDF not PdfPig/C#); update M1/M2 milestone descriptions and gantt section labels - 07_repo_structure: replace C# project tree (QuickGuide.Api/, .sln, wwwroot/, python_worker/) with actual directory layout (src/main.py, src/services/, src/static/); update naming conventions and key dirs table - 08_risk_register: R-02 PdfPig→PyMuPDF; R-05 retitled and rewritten for single Python runtime; R-08 PdfPig→PyMuPDF; R-09 retitled and rewritten for FastAPI process startup failures https://claude.ai/code/session_01SPUUZCfAfzQ7Kna5JGCZSD
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.
…base
The original planning docs described a C# ASP.NET Core + Python Flask dual-runtime architecture that was never implemented. The actual codebase is a single-process Python FastAPI application. Updated six documents to accurately reflect the implementation:
https://claude.ai/code/session_01SPUUZCfAfzQ7Kna5JGCZSD