Skip to content

docs: complete explanation pages and expand guide and reference sections#157

Merged
nikazzio merged 2 commits intomainfrom
docs/content-updates
Apr 17, 2026
Merged

docs: complete explanation pages and expand guide and reference sections#157
nikazzio merged 2 commits intomainfrom
docs/content-updates

Conversation

@nikazzio
Copy link
Copy Markdown
Owner

Summary

  • Rewrote three stub explanation pages (architecture, job-lifecycle, security-and-path-safety) from bullet placeholders to full prose, grounded in actual code behavior.
  • Expanded four moderate pages (getting-started, first-manuscript-workflow, discovery-and-library, cli) with real features verified against source: wizard mode, download manager, acquisition granularity, path safety patterns, status machine.

Changes

File Before After
explanation/architecture.md 25 lines 97 lines
explanation/job-lifecycle.md 26 lines 106 lines
explanation/security-and-path-safety.md 15 lines 91 lines
getting-started.md 83 lines 122 lines
first-manuscript-workflow.md 81 lines 111 lines
discovery-and-library.md 103 lines 139 lines
reference/cli.md 55 lines 111 lines

All 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 locally
  • check_docs_integrity.py — passed locally
  • markdownlint — passed locally

Related #66
Related #67

nikazzio and others added 2 commits April 13, 2026 21:58
…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>
@nikazzio nikazzio added area:roadmap Meta planning/tracking issue priority:P2 Medium priority semver:none No release impact by itself type:docs Documentation work labels Apr 17, 2026
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.95%. Comparing base (ee55fa4) to head (66063b8).
⚠️ Report is 1 commits behind head on main.

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     
Flag Coverage Δ
fast 70.93% <ø> (ø)
slow 70.95% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nikazzio nikazzio merged commit 00bf98a into main Apr 17, 2026
9 of 10 checks passed
@nikazzio nikazzio deleted the docs/content-updates branch April 17, 2026 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:roadmap Meta planning/tracking issue priority:P2 Medium priority semver:none No release impact by itself type:docs Documentation work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants