Skip to content

docs: post-v1.0.6 documentation quality review#12

Merged
sparshsam merged 1 commit into
mainfrom
docs/post-v1.0.6-doc-review
Jun 11, 2026
Merged

docs: post-v1.0.6 documentation quality review#12
sparshsam merged 1 commit into
mainfrom
docs/post-v1.0.6-doc-review

Conversation

@sparshsam

Copy link
Copy Markdown
Owner

Summary

Documentation-only quality review and refinement after the v1.0.6 release. Covers four files across README, release announcement, screenshot audit, and v1.1.0 planning.

No application code, workflows, CI, or release assets were touched.

Changes

README.md

  • Fix table separator (extra column in the header divider row)
  • Fix ASCII tree formatting (|├── on the root .github/ entry)
  • Update "Last updated" from July to June 2026
  • Flesh out Tech Stack table with real technologies (PySide6, PyMuPDF, SQLite FTS5/BM25, Inno Setup, Bandit, etc.) — previously it only said "Python / Cross-platform / Desktop native"

docs/v1.1.0-plan.md

  • Reorder priorities so UI polish (tab styling, start screen, thumbnail sidebar) comes before screenshot refresh, and rendering work comes before distribution/packaging work
  • Rename "Better current UI screenshots" → "Updated UI screenshots" with note to take them after polish is applied

docs/announcements/v1.0.6.md

  • Add a Short Version section at the top — a concise 4-line summary suitable for release notes or social sharing
  • Existing full-content moves under Long Version (unchanged)

docs/screenshot-audit.md

  • Fix audit date (July → June 2026)
  • Add exact target filenames, README placement guidance, and capture instructions for each missing screenshot
  • Add PNG optimization subsection with specific tools (pngquant, oxipng, TinyPNG) and size targets (~200–300 KB)

Verification

  • Base commit: fbca59b
  • All internal links verified valid
  • All referenced assets confirmed present on disk (screenshot-main.png, screenshot-search.png, etc.)

🤖 Generated with Claude Code

Refinements across four documentation files after v1.0.6 release:

README.md
  - Fix table separator (extra column in header divider)
  - Fix ASCII tree root-line character (| -> ├──)
  - Update 'Last updated' from July to June 2026
  - Flesh out Tech Stack table with actual technologies
    (PySide6, PyMuPDF, SQLite FTS5, Inno Setup, etc.)

docs/v1.1.0-plan.md
  - Reorder priorities: UI polish before screenshots,
    rendering before distribution work

docs/announcements/v1.0.6.md
  - Add short announcement version for social/release-summary use
  - Demote existing content to long version

docs/screenshot-audit.md
  - Fix audit date (July -> June 2026)
  - Add exact target filenames and README placement for each
    missing screenshot
  - Add PNG optimization guidance (tools, size targets)

No application code, workflows, CI, or release assets touched.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@sparshsam sparshsam merged commit 4b6a4e3 into main Jun 11, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants