Skip to content

docs: overhaul product documentation and localized READMEs - #229

Merged
ThisIs-Developer merged 7 commits into
mainfrom
docs/international-documentation-audit
Jul 27, 2026
Merged

docs: overhaul product documentation and localized READMEs#229
ThisIs-Developer merged 7 commits into
mainfrom
docs/international-documentation-audit

Conversation

@ThisIs-Developer

@ThisIs-Developer ThisIs-Developer commented Jul 27, 2026

Copy link
Copy Markdown
Owner

What changed

  • audited the existing Markdown documentation against the current implementation
  • reorganized the root README as a concise product overview and documentation entry point
  • corrected Share Snapshot, Live Share, Docker/PWA, renderer, import-limit, privacy, and storage claims
  • added focused pages for Privacy and Security, Share Snapshot, and troubleshooting
  • combined the localization workflow and complete five-language terminology glossary in wiki/Localization.md
  • revised the Japanese, Korean, and Simplified Chinese README files and added a Traditional Chinese README
  • synchronized terminology and navigation across all five documentation entry points
  • added CodeWiki and DeepWiki entry badges, the independently maintained Markdown Desk showcase, a short development journey, and the contributor gallery to all five README files
  • clarified the verified combination that distinguishes Markdown Viewer and added localized, collapsible 12-entry tables of contents to all five README files
  • updated the product positioning and synchronized six application, renderer, and Live Share screenshots with localized alternative text across all five README files

Why

The previous documentation contained duplicated overview content, fragile links, inconsistent translated terminology, missing privacy and retention details, and several statements that no longer matched the implementation. This change makes the codebase the source of truth and separates concise entry-point content from detailed reference pages.

User and developer impact

Users receive clearer installation, usage, sharing, privacy, security, network, troubleshooting, project-history, community, and product-positioning guidance. Collapsible contents blocks and synchronized screenshots make each README easier to navigate and understand. Contributors receive a consolidated localization workflow and terminology reference. No application logic, API, storage format, dependency, deployment configuration, or product behavior is changed.

Validation

  • validated 24 Markdown files for one top-level heading, Unicode integrity, balanced fences, local paths, and anchors
  • resolved 306 internal documentation links and heading anchors
  • confirmed all five README entry points have matching 12-section structure, synchronized positioning, six matching screenshots, localized alternative text, language labels, and peer navigation
  • confirmed all 33 previously linked external documentation URLs and images responded successfully at their validation time
  • identified that all six newly added github.com/user-attachments screenshot URLs return HTTP 404 to anonymous readers even though authenticated owner requests succeed; these images require stable public URLs or repository-local copies before merge
  • parsed all 14 UI locale catalogs and matched them to the 1,072-key English catalog
  • confirmed the removed standalone files have no remaining documentation references
  • git diff --check passed
  • confirmed all 23 changed or added paths are Markdown documentation
  • focused Chromium tests passed for Share Snapshot temporary-tab behavior and Private mode local-storage behavior

npm run build remains blocked by the pre-existing static-validator reference to missing functions/api/report-issue.js. This documentation-only change does not create or alter that condition.

Before merge: replace or publish the six authentication-gated README screenshot assets so they render for readers who are not signed in to GitHub.

@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
markdown-viwer Ready Ready Preview, Comment Jul 27, 2026 9:18pm

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 27, 2026

Copy link
Copy Markdown

Deploying markdownviewer with  Cloudflare Pages  Cloudflare Pages

Latest commit: daf0e14
Status: ✅  Deploy successful!
Preview URL: https://a5294cb5.markdownviewer.pages.dev
Branch Preview URL: https://docs-international-documenta.markdownviewer.pages.dev

View logs

@ThisIs-Developer ThisIs-Developer changed the title docs(wiki): improve international documentation docs: improve international documentation Jul 27, 2026
@ThisIs-Developer ThisIs-Developer changed the title docs: improve international documentation docs: overhaul product documentation and localized READMEs Jul 27, 2026
@ThisIs-Developer
ThisIs-Developer marked this pull request as ready for review July 27, 2026 21:31
@ThisIs-Developer
ThisIs-Developer merged commit acb2f15 into main Jul 27, 2026
5 checks passed
@ThisIs-Developer
ThisIs-Developer deleted the docs/international-documentation-audit branch July 27, 2026 21:33
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.

1 participant