docs: comprehensive refresh — README, API reference, user manuals (EN + zh-TW), screenshots - #13
Merged
Merged
Conversation
…, and yara config
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.
Comprehensive documentation pass covering the optimization work, the multi-provider LLM integration, the OSINT/UX fixes, and the YARA rules configuration.
What changed
docs/API.md,docs/api/README.md, zh-TW landing): every endpoint (19 routes) now has a detailed explanation, a completecurlsample request, an exact-shape sample JSON response with status code, and per-endpoint error variants. Reconciled 1:1 against the livecreate_app()route table — zero missing, zero phantom. Fixed 10 real code-vs-docs drifts (key-ID format, env-var semantics, naive-vs-Ztimestamps, the undocumented STIX alias route, etc.).docs/en/USER_MANUAL.md+ fulldocs/zh-TW/tree): new-analyst walkthrough of every tab and feature — explainable risk, honest provider-status pills, LLM Integration (LM Studio / OpenAI / Anthropic), YARA rules config, per-run artifact retention. zh-TW is Traditional Chinese with Taiwan-standard wording (verified clean of Simplified terms).sample.pcaprun (real data, IPs auto-redacted) plus a new09-llm-providers.png.scripts/install.py,scripts/check_dependencies.py): dependency check now covers all current runtime packages (anthropic,kaleido,plotly, fastapi/uvicorn, …) with required/optional markers; added the missing Linux WeasyPrint package (libpangocairo-1.0-0+ font/mime deps) to match the Dockerfile/CI set.scripts/capture_screenshots.py): hardened — container-relative--pcap, fail-fast on a rejected path, waits for the LLM report, captures the provider close-up.Verification
make verify— 1000 passed, ruff format + lint clean.