[claude] Add FieldWorks Lite and Lexbox documentation site - #2518
Closed
myieye wants to merge 14 commits into
Closed
[claude] Add FieldWorks Lite and Lexbox documentation site#2518myieye wants to merge 14 commits into
myieye wants to merge 14 commits into
Conversation
docs/ becomes a Docusaurus site with a user guide and technical section, seeded from existing README/AGENTS.md content. The user guide's 'How sync works' page is an interactive question-driven explainer (all content in docs/src/components/SyncExplainer/syncScenarios.ts). DOCS-PLAN.md records the tooling survey and decisions. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Named type imports in the Docusaurus config, Boolean() coercions, content-derived keys, arrow-const components, and Topology/Stepper extracted from SyncExplainer. DOCS-PLAN.md gains the FieldWorks Classic docs relationship and the React-vs-Svelte decision with its revisit trigger. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Lets CI deploy previews to another host (e.g. a fork's GitHub Pages) until the production URL is decided. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
persist-credentials off in the docs workflow checkout, correct the shared-storage claim in the system overview, read-only credential check in the dev setup, FAQ headings to level 2. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Empty split parts produced duplicate position keys; skip them and count the ** markers when advancing. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Correct the platform list (no Mac or iOS builds ship), add a scenario step disclosing that the FW Lite Sync button and the project page's 'Sync FieldWorks Lite' are the same action, and add a 'Where you'll see this in the app' section mapping each leg to its dialog tab, statuses, and buttons. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The always-reserved space read as a dead gap between the device box and leg 1, worst on mobile. Also tell pure-FieldWorks-Lite teams up front that legs 2 and 3 don't concern them. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Ground "Lexbox" for FieldWorks Lite users in the user-guide index and a new FAQ, so the FWL guide stays self-contained and doesn't assume readers know or visit Lexbox. - Explain the sync snapshot as the JSON file recording the last merged state (the diff baseline, and the "have we synced before?" flag), instead of using the bare term "ProjectSnapshot". - Make the explainer diagram interactive: the three leg triggers are now tap/click toggletips (touch + keyboard + screen-reader friendly) that reveal where the Sync button lives and that its two names are the same action. - Color the diagram's leg numbers at rest to match the numbered table below, so a leg in the diagram ties to its row. - Put the caption and stepper directly under the diagram in one "player" card so the controls read as driving the picture; compact the phone layout and scroll the player into view on select so the diagram and Next are co-visible. - Turn the diagram vertical by container width (not viewport) so the wide horizontal layout never overflows the docs column into the sidebars. - Give the page real section headings so "On this page" lists the first section instead of starting mid-page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TZKRnigoAXxEWZVJFrto1k
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (5)
📒 Files selected for processing (34)
📝 WalkthroughWalkthroughChangesAdds a Docusaurus documentation site with user and technical sections, GitHub Pages deployment, reorganized setup links, detailed sync documentation, and an interactive responsive sync explainer. Documentation site
Estimated code review effort: 4 (Complex) | ~60 minutes Suggested labels: Poem
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
2 participants
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.
[Claude, autonomous]
Adds a Docusaurus docs site for FieldWorks Lite and Lexbox — a user guide, technical/sync docs, and an interactive "How sync works" explainer — and wires up a GitHub Pages deploy workflow.
https://raw.githubusercontent.com/sillsdev/languageforge-lexbox/4d394f0f2150e4ca5747cd8c9a125637a0c7b8b2/claude/fw-lite-lexbox-docs-0e3415-hwa2rw/b281e81ab3b866cb.png">https://raw.githubusercontent.com/sillsdev/languageforge-lexbox/9c92dbe1100e078342d1b3ed76ea9ca0a125045f/claude/fw-lite-lexbox-docs-0e3415-hwa2rw/7360fb7e0652828a.png">What's here
docs/user-guide/) — getting started, FAQ, and the sync explainer, written for non-technical FieldWorks Lite users. Lexbox is grounded once and kept out of the way so pure-FWL readers aren't confused.docs/technical/) — the sync chain, the FwHeadless merge, CRDT notes, dev setup.docs/src/components/SyncExplainer/) — one fixed diagram that replays per question, with a learner-paced stepper. Trigger pills are tap/keyboard/screen-reader toggletips; the diagram flips vertical by container width so it never overflows the docs column.docs.yaml— builds the site on every docs PR and deploys to GitHub Pages fromdevelop.DOCS-PLAN.md.How this reaches GitHub Pages
There is no live docs site yet —
developstill has only the olddocs/DEVELOPER-*.mdfiles. This PR is what turns the site on:develop.docs.yamlbuilds on every docs PR (a check on this PR) but the deploy job is gated torefs/heads/develop, so the site publishes only once this lands.github-pagesenvironment the deploy job targets; without it the deploy step fails.url: https://docs.lexbox.org,baseUrl: /, both overridable viaDOCS_URL/DOCS_BASE_URL. For a custom domain, set the Pages custom domain todocs.lexbox.org(DNS CNAME →sillsdev.github.io) and keepbaseUrl: /. To use the default project URL instead, deploy withDOCS_BASE_URL=/languageforge-lexbox/so assets resolve athttps://sillsdev.github.io/languageforge-lexbox/.Test plan
pnpm --dir docs typecheckandpnpm --dir docs buildboth green.Notes
developbut the changes are docs-only (no overlap with recent work), so it merges cleanly.🤖 Generated with Claude Code
Generated by Claude Code