Skip to content

docs(readme): clarify product, AI, WebMCP and PWA capabilities - #263

Merged
chaxus merged 9 commits into
mainfrom
docs/product_readme
Oct 13, 2026
Merged

chaxus merged 9 commits into
mainfrom
docs/product_readme

Conversation

@chaxus

@chaxus chaxus commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Summary

The README mixes the product introduction with a long technical manual and obscures optional AI, agent and PWA capabilities. Give readers a concise product overview across all eight languages: open-source positioning, a two-paragraph introduction covering the full core capability set, six user benefits, direct editor shortcuts and supported formats.

The six benefits cover local editing/conversion, saving/recovery, AI assistance (Experimental Beta), WebMCP agent tools, PWA installation with cached offline resources, and self-hosting/embedding. Briefly surface multilingual interfaces, themes and read-only preview; include local/custom AI services and browser speech input in the later AI section. Preserve the four existing demo videos, upstream acknowledgements and legal text.

Design Decisions

Use plain text titles, ordinary Markdown and native expandable sections. Display edit.chaxus.com explicitly in the live CTA and remove the redundant source CTA. Localize help-page links where the site provides that language. Move technical instructions into docs/reference.md. Keep the detailed AI demos later in the page, with Beta and default-off wording. Replace the duplicate quick-start link row with direct new-document, spreadsheet and presentation links.

Use task-oriented copy informed by the official Excalidraw, AFFiNE and Open WebUI READMEs, without adopting their long feature lists or promotional claims.

Risk Analysis

Documentation only. Make browser-agent ownership of returned content explicit. Preserve offline prerequisites, recovery retention, optional AI data handling and WebMCP browser requirements. Direct WebMCP full-text reading is limited to word-processing documents; document this in the overview and technical guide.

Verification

  • 56 README locale and branding/notice tests passed on the final version.
  • Repository formatting check passed; final touched-file formatting and git diff --check passed.
  • Final actual GitHub Chinese preview checked at 375px and 320px: no page overflow, no title images, live URL visible and no redundant source CTA. All eight intros include Word/Excel/PowerPoint/PDF, AI Beta, WebMCP and PWA.
  • Local Markdown links, the WebMCP anchor, editor shortcuts and all eight language switchers verified.
  • GitHub loaded all four native demo videos without media errors; their attachment URLs and legal text are preserved.
  • Remote tree matches the verified local commit tree.

Code Concerns

No blocking documentation findings.

Merge Verdict

Ready for review; hosted checks are running on the latest revision.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Deploying document with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0e3e1db
Status: ✅  Deploy successful!
Preview URL: https://47cb406a.document-7hm.pages.dev
Branch Preview URL: https://docs-product-readme.document-7hm.pages.dev

View logs

@chaxus chaxus changed the title docs(readme): simplify product overview and technical reference docs(readme): clarify product, AI, WebMCP and PWA capabilities Oct 13, 2026
@chaxus
chaxus enabled auto-merge (rebase) October 13, 2026 03:38
@chaxus
chaxus merged commit 3a3dcae into main Oct 13, 2026
20 checks passed
@chaxus
chaxus deleted the docs/product_readme branch October 13, 2026 03:42
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