Skip to content

docs(v2): trim, dedupe, and split the docs for clarity - #241

Open
V3RON wants to merge 2 commits into
mainfrom
docs/v2-cleanup
Open

docs(v2): trim, dedupe, and split the docs for clarity#241
V3RON wants to merge 2 commits into
mainfrom
docs/v2-cleanup

Conversation

@V3RON

@V3RON V3RON commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

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?

  • Cut "how it works under the hood" internals that don't affect usage: the internal wire/payload format, architecture diagrams, internal library/crypto names, and SwiftUI-modifier/Canvas-rendering explanations.
  • Removed content duplicated across pages (plugin config blocks, "how build assets work" lists, repeated caveats like the iOS refresh throttle or Android's "opens the app when clicked") in favor of one canonical explanation with a link.
  • Rewrote formal or marketing-toned openers into plain, direct language across the getting-started and platform intro pages.
  • Split three overlong pages that mixed unrelated topics: ios/development/styling.md into styling/gradients/custom-fonts, android/api/plugin-configuration.md into config/widget-sizing-and-previews, and android/development/managing-ongoing-notifications.md (522 lines) into local-lifecycle vs. remote/push integration.
  • Added expo-widgets to Prior Art as a practical (not just theoretical) example of driving Live Activities/widgets from a secondary JS runtime.
  • Fixed the voltra CLI install snippet: --save-dev isn't supported by yarn or bun, only -D works across npm/yarn/pnpm/bun.
  • Fixed a few bugs found along the way: a broken code fence rendering two sections as a literal code block, a page that existed but wasn't reachable via the sidebar, missing RN imports in a quick-start sample, and dangling links left by the page splits.

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.

V3RON added 2 commits August 13, 2026 10:39
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.
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