docs: add getting started and code push sections#2
Merged
Conversation
felangel
commented
Apr 24, 2023
| # Overview | ||
|
|
||
| Welcome to the Shorebird docs. | ||
| Welcome to Shorebird 👋 |
Contributor
Author
There was a problem hiding this comment.
Will come back to this in a subsequent PR.
eseidel
reviewed
Apr 24, 2023
eseidel
left a comment
eseidel
left a comment
Contributor
There was a problem hiding this comment.
I didn't read it all the way (yet). Is it staged somewhere we could see it that way?
|
|
||
| # Build your Shorebird App | ||
|
|
||
| You can use `shorebird build` to build a release version of your app including code push: |
Contributor
There was a problem hiding this comment.
release is generally the main flow, no?
Contributor
Author
There was a problem hiding this comment.
Yeah build is last in this section.
Contributor
Author
GitHub actions is down atm so the quickest way to see it would be to check out the branch and run it locally. |
eseidel
approved these changes
Apr 25, 2023
eseidel
left a comment
eseidel
left a comment
Contributor
There was a problem hiding this comment.
I didn't review this in detail. I think we should just land this and I will wordsmith and send you a PR. :)
3 tasks
tomarra
added a commit
that referenced
this pull request
Jul 2, 2026
* docs: use sentence case for headers
Per the marketing content guidelines, headers should use sentence
case, not Title Case. Fixes 169 headings across 44 files.
Left several categories of heading untouched, all confirmed by
testing directly against Vale rather than guessing:
- Compound product/brand names where per-word exception matching
breaks down and partially-casing the phrase reads worse than the
original: "Azure Key Vault", "GCP Cloud KMS", "App Store Connect",
"Firebase Remote Config", "Launch Darkly", "Flutter Hot Reload".
- Three "Flutter vs. X" headings: Vale's capitalization rule flags
any heading containing "vs"/"vs." regardless of surrounding case,
a hardcoded quirk that isn't configurable via the exceptions list.
- Four "code push" FAQ headings (e.g. "Does code push require the
internet to work?"): enabling the Vocab-driven proper-noun rule
causes Vale's capitalization rule to also flag any lowercase vocab
term (Shorebird/Flutter/Code Push) in a heading, even though sentence
case itself has no violation here. These already get fixed by the
proper-noun-capitalization PR; no separate edit needed here.
- Three sequential numbered headings ("1. The Status Enum", "2. The
Single State Class", "3. The Events"): Vale's algorithm inexplicably
passes #2 once lowercased but keeps flagging #1 and #3 with
identical structure. Reverted all three to Title Case to keep the
numbered list visually consistent rather than partially complying.
Also discovered and fixed real proper nouns that weren't yet
recognized by the Headings rule's exceptions list (Stripe, Fastfile,
BuildContext, RenderObject, Apple, 1Password, AOT, GuardSquare, LTS,
ExportOptions.plist, Skia, Impeller) and two headings using lowercase
"fastlane" where the tool name should be capitalized ("Using Fastlane
on CI/locally"). These exceptions need to land in the tooling PR
(#576) as well, or they'll show as false positives again once these
two PRs both merge.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
* fix comments
* fix comments
---------
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
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.
Status
READY
Description
Type of Change