docs(v2): trim, dedupe, and split the docs for clarity - #241
Open
V3RON wants to merge 2 commits into
Open
Conversation
Cut internal implementation details (wire formats, architecture diagrams, internal library names), removed content duplicated across pages, rewrote formal/marketing-toned passages into plain language, split overlong pages (styling, plugin-configuration, managing-ongoing-notifications), and fixed a broken code fence, an unreachable page, and a couple of dangling links found along the way. Also added expo-widgets as prior art and fixed the --save-dev flag in the Voltra CLI install command, which isn't supported by yarn or bun.
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.
What is this?
A cleanup pass over the v2 docs (
website/docs/v2) so pages only cover what a Voltra user actually needs to use the library correctly, without implementation internals, duplicated explanations, or overlong pages mixing unrelated topics.How does it work?
ios/development/styling.mdinto styling/gradients/custom-fonts,android/api/plugin-configuration.mdinto config/widget-sizing-and-previews, andandroid/development/managing-ongoing-notifications.md(522 lines) into local-lifecycle vs. remote/push integration.expo-widgetsto Prior Art as a practical (not just theoretical) example of driving Live Activities/widgets from a secondary JS runtime.voltraCLI install snippet:--save-devisn't supported by yarn or bun, only-Dworks across npm/yarn/pnpm/bun.Why is this useful?
Shorter, non-duplicated, jargon-free pages are faster to scan and less likely to drift out of sync with each other. The page splits make each topic independently linkable and easier to maintain going forward.