Skip to content

docs: copy-edit pass over dashboard, SSO, iOS and integrations pages - #34

Merged
krassx merged 1 commit into
mainfrom
docs/copy-edit-pass
Sep 2, 2026
Merged

docs: copy-edit pass over dashboard, SSO, iOS and integrations pages#34
krassx merged 1 commit into
mainfrom
docs/copy-edit-pass

Conversation

@krassx

@krassx krassx commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Replaces #28, which GitHub auto-closed when its base branch was deleted during the stacked merge. Same commit, now based directly on main. Nothing was lost.

One-off grammar and punctuation slips — no semantic changes. These cluster on the older pages (dashboard, SSO, integrations) that the recent revamp did not reach.

By area

Dashboard — four you/your mix-ups ("Open you app", "you authentication application", "persist you search criteria" ×2), plus missing articles and prepositions on search.md: "Provide meaningful name", "click 'Save' in the right side", "As you may guessed", "clicking at the trash icon", "click at star icon".

SSO instructions — JumpCloud had italic markers placed inside the closing quote (_"IDP Entity ID_"_"IDP Entity ID"_), which renders a stray _; the correctly-formatted _"SP Entity ID"_ on the same line settled the direction. Same on "Sign assertion" and "Fields Map". Also "must match to the values" and a doubled verb: "is, on the contrary, is checked". Azure: "Navigate to your Azure.""your Azure portal." AWS: stray space in a quoted UI string, and "the rest fields""the remaining fields".

iOS"and recording everything", "Do no trigger upload" ×2 (worth fixing since it is phrased as a warning), "prevent some data of being collected", "To cleanup up those, use corresponding API".

Android"Stops Bugsee being added to build variants""Prevents Bugsee from being added…".

Integrations"Mostly integration flows have similar steps sequence", "We do not apply any limitations to both username and password", "what format they expect when is set in recipe result", "unified … to the ones being used", "Note, that result is not used as is."

index.md"Installing React Native Module""SDK".

Conflict resolution carried forward

config-aws.md:38 is one sentence carrying three separate fixes, split across two sides: already-merged #27 supplied attribute names and the Bugsee, this PR supplies remaining fields. All three are kept, and each was verified independently after the cherry-pick.

Deliberately NOT fixed

config-jumpcloud.md:36 says to fill in the "IdP-initiated URL" only if you want to force the "SP-initiated authentication SSO". That reads backwards — but confirming the direction needs someone who can open the JumpCloud console. I fixed only the unambiguous formatting on that line and left the instruction alone.

Also left: "controlling entities" in recipes_issues.mdx:156 probably means "control characters", but I am not confident enough about the escaping behaviour being described to rewrite it.

Checks

npx cspell 288 files / 0 issues · npm run build succeeds, no broken links

🤖 Generated with Claude Code

One-off grammar and punctuation slips, mostly on older pages the recent
revamp did not touch. No semantic changes.

dashboard/accounts/2fa.md, dashboard/search.md
  Four you/your mix-ups ("Open you app", "you authentication
  application", "persist you search criteria" x2), plus missing
  articles and prepositions on search.md ("Provide meaningful name",
  'click "Save" in the right side', "As you may guessed", "clicking at
  the trash icon", "click at star icon").

SSO instruction pages
  JumpCloud: italic markers placed inside the closing quote
  (_"IDP Entity ID_" -> _"IDP Entity ID"_, and the same for
  "Sign assertion" and "Fields Map"); "must match to the values" ->
  "must match the values"; doubled verb in "is, on the contrary, is
  checked".
  Azure: "Navigate to your Azure." -> "your Azure portal."
  AWS: stray space inside a quoted UI string; "the rest fields" ->
  "the remaining fields".

iOS SDK
  "and recording everything" -> ", recording everything";
  "Do no trigger upload" -> "Do not trigger upload" (x2, in a warning
  comment); "prevent some data of being collected" -> "from being";
  "To cleanup up those, use corresponding API" -> "To clean those up,
  use the corresponding API".

Android
  "Stops Bugsee being added to build variants" -> "Prevents Bugsee from
  being added to build variants".

Integrations
  "Mostly integration flows have similar steps sequence" -> "Most
  integration flows have a similar sequence of steps"; "We do not apply
  any limitations to both username and password" -> "We impose no
  restrictions on username or password"; "when is set in recipe result"
  -> "when it is set in the recipe result"; "unified ... to the ones
  being used" -> "with the ones used"; "Note, that result is not used as
  is." -> "Note that the result is not used as-is."

index.md
  "Installing React Native Module" -> "Installing React Native SDK" —
  the only entry in the list not saying "SDK".

Deliberately not touched: the JumpCloud instruction to fill in the
"IdP-initiated URL" only to force "SP-initiated" SSO. That reads
backwards, but confirming the intended direction needs someone with
JumpCloud console access. Only the unambiguous formatting problems on
that line are fixed here.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Change-Id: Ia111bc4e6a5e50a8c5ef780fd82ec4bf4ef96721
@krassx
krassx merged commit 389e481 into main Sep 2, 2026
1 check passed
@krassx
krassx deleted the docs/copy-edit-pass branch September 2, 2026 04:12
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