docs: [intern-34] Documentation audit: update CLAUDE.md + README + architecture diagram - #429
Open
CodingMinh wants to merge 1 commit into
Open
docs: [intern-34] Documentation audit: update CLAUDE.md + README + architecture diagram#429CodingMinh wants to merge 1 commit into
CodingMinh wants to merge 1 commit into
Conversation
…gging guide - Add Mermaid architecture diagram to README.md illustrating data flow across crates, clients, and native runtimes. - Add comprehensive CLI subcommand reference and environment variable table to README.md. - Update CLAUDE.md with workspace crate mapping (knowledge, server, mcp) and native probe details. - Add 'Debugging & Common Pitfalls' section to CLAUDE.md covering PDFium fallback, Whisper linking/models, Vision OCR config, and TCVN3 legacy font hints. Closes #372
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.
Summary of Changes
This PR addresses issue #372 by performing a documentation audit across
README.mdandCLAUDE.mdto resolve gaps, provide missing command references, and document architecture/debugging practices.1. Gaps Identified & Resolved
crates/knowledge,crates/server, andcrates/mcpdescriptions inCLAUDE.mdand updated PPTX page probing from legacy python script references to native Rust probing.one,one-detailed,speed,accuracy,audio,handoff,pptx-preview,info) and full environment variables list (FILECONV_OCR_*,FILECONV_LLM_*,FILECONV_PDFIUM_LIB,FILECONV_WHISPER_*) toREADME.md.CLAUDE.mdcovering PDFium missing lib, Whisper build/models setup, Vision OCR API configuration (DependencyMissing), and TCVN3 uppercase font handling.2. Architecture Diagram
README.mdillustrating data flow and boundaries between Clients (app/,web/,crates/mcp,crates/cli), Rust Core & Contracts (crates/core,crates/knowledge,crates/server), and Native Runtimes / Cloud APIs.Verification
crates/cli/src/main.rs.Closes #372