Repository navigation
docs(readme): clarify product, AI, WebMCP and PWA capabilities - #263
Merged
Merged
Conversation
Deploying document with
|
| 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 |
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
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.comexplicitly in the live CTA and remove the redundant source CTA. Localize help-page links where the site provides that language. Move technical instructions intodocs/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
git diff --checkpassed.Code Concerns
No blocking documentation findings.
Merge Verdict
Ready for review; hosted checks are running on the latest revision.