docs: complete explanation pages and expand guide and reference sections#157
Merged
docs: complete explanation pages and expand guide and reference sections#157
Conversation
…e_tamburo logo - replace scriptoria-header.svg with morte_tamburo.png in hero section - rewrite 'Why Scriptoria?' block with Wikipedia-derived historical text - tighten intro paragraphs to sound less AI-generated - copy assets/morte_tamburo.png to static/img/ for Docusaurus Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- rewrite architecture.md from stub to full explanation of the three-layer dependency model, core service areas, and end-to-end flow - rewrite job-lifecycle.md with real status machine (queued/running/ cancelling/pausing → paused/cancelled/completed/error), staging model, and resume-safety semantics - rewrite security-and-path-safety.md with _is_within pattern, ConfigManager as path root source, sanitize_filename, centralized HTTP client rule, SQL parameterization, and CORS posture - expand getting-started.md: --version verification, --reload flag, port 8000 note, wizard CLI mode, config first-run section, troubleshooting pointer - expand first-manuscript-workflow.md: Add and download action, Library catalog actions, granular acquisition (full/range/missing/retry), download manager lifecycle, per-page Output actions (Scarica/Hi-res/Opt) - expand discovery-and-library.md: supports_search(), probe manifest, PDF capability check, full acquisition actions surface, catalog maintenance actions (set_type, notes, refresh, reclassify, normalize) - expand cli.md: wizard mode walkthrough, --version, output paths via ConfigManager, status icons, valid set-status values, legacy alias note Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #157 +/- ##
==========================================
+ Coverage 70.93% 70.95% +0.02%
==========================================
Files 153 153
Lines 13229 13229
==========================================
+ Hits 9384 9387 +3
+ Misses 3845 3842 -3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
Changes
explanation/architecture.mdexplanation/job-lifecycle.mdexplanation/security-and-path-safety.mdgetting-started.mdfirst-manuscript-workflow.mddiscovery-and-library.mdreference/cli.mdAll content verified against
jobs.py,vault_jobs.py,utils.py,network_policy.py,cli.py, and route handlers. No new files; no code changes.CI Checks
check_docs_language.py— passed locallycheck_docs_integrity.py— passed locallymarkdownlint— passed locallyRelated #66
Related #67