Skip to content

Modernize docs - #6

Merged
ofalvai merged 1 commit into
masterfrom
push-rlrkzlxmqtts
Jul 30, 2026
Merged

Modernize docs#6
ofalvai merged 1 commit into
masterfrom
push-rlrkzlxmqtts

Conversation

@ofalvai

@ofalvai ofalvai commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Context

The main user-facing documentation is at docs/api-js.md. It's a good mix of a how-to guide, explanation and reference doc, and it's not in the scope of this PR to untangle that, but at least start to improve the current docs.

Changes

Two themes:

  1. Most of this doc was written before functional React components. Rewrite examples for modern React use.
  2. Re-order the doc to start with the "how-to guide" style high-level walkthrough, then document the entire API surface area.

Out of scope

  • README.md update: bigger rewrite, follow-up PR
  • Where should documentation live: probably not in this repo, or only keep the API reference here? Bigger discussion.
  • Make sure codePush.sync() handles app lifecycle events: this was lost with functional React components. We could probably introduce a hook for this, but it's out of scope now.

@ofalvai
ofalvai force-pushed the push-rlrkzlxmqtts branch from 3306ede to 92cda4a Compare July 28, 2026 14:53
@ofalvai
ofalvai force-pushed the push-rlrkzlxmqtts branch from 92cda4a to 59f6671 Compare July 30, 2026 07:54
@ofalvai
ofalvai marked this pull request as ready for review July 30, 2026 07:55
@ofalvai
ofalvai merged commit d23b044 into master Jul 30, 2026
3 checks passed
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.

2 participants