Skip to content

docs: add a GitHub sign-in page with the IP allow list addresses - #417

Merged
gsavage merged 2 commits into
mainfrom
docs/github-sign-in-page
Sep 15, 2026
Merged

gsavage merged 2 commits into
mainfrom
docs/github-sign-in-page

Conversation

@gsavage

@gsavage gsavage commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds administration/authentication/github_login.md, a how-to page for signing in to Kosli with GitHub, placed in Administration ▸ Authentication & access next to single sign-on and Magic Link.
  • Documents the GitHub IP allow list case: Descope completes the OAuth exchange with GitHub from fixed IP addresses, so customers with an allow list must add them. Lists the Descope Project Static IPs per Kosli instance (EU for app.kosli.com, US for app.us.kosli.com), sourced from Descope's public static IPs page.
  • Links the new page from the existing "Why is my GitHub login failing?" FAQ entry and from the getting-started authentication page, which previously named GitHub as a sign-in method with nothing to link to.

Verification

  • pytest tests/ passes (44 tests, including navigation integrity).
  • python scripts/audit_navigation.py --check reports no integrity findings.
  • mint broken-links could not run locally (Mintlify CLI does not support Node 25); every root-relative link in the changed files was checked against the filesystem instead.

Reviewer note

The sign-in step says "Select the GitHub option on the sign-in page" rather than quoting a button label, because I could not confirm the exact label. If it is Continue with GitHub, that wording can be tightened.

🤖 Generated with Claude Code

GitHub was the only sign-in method with no page of its own; the single FAQ
entry covered just the verified-email requirement. A customer whose GitHub
organization enforces an IP allow list could not sign in, because Descope,
Kosli's identity provider, completes the OAuth exchange with GitHub from a
fixed set of IP addresses that GitHub rejected.

Add administration/authentication/github_login under Authentication & access,
alongside single sign-on and Magic Link. It covers the verified-email
requirement, the sign-in steps, and the Descope Project Static IPs to allow,
split by Kosli instance: app.kosli.com uses the EU set and app.us.kosli.com
uses the US set. The FAQ entry and the getting-started authentication page now
link to it.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@gsavage
gsavage requested a review from a team as a code owner September 15, 2026 08:26
@mintlify

mintlify Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
kosli 🟢 Ready View Preview Sep 15, 2026, 8:43 AM

@claude

claude Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Claude finished @gsavage's task in 2m 5s —— View job


Doc review — PR #417

  • Read the doc-review skill and repo conventions
  • Read changed files at branch HEAD (8c82eb4)
  • Cross-check navigation, links, anchors, and sibling pages
  • Post findings

Nav entry is present (config/navigation.json:50), every root-relative link in the changed files resolves to a file that exists, and the FAQ's #github-ip-allow-lists anchor matches the heading at administration/authentication/github_login.md:34. mint broken-links and gh pr checks were not runnable in this environment, so link targets were verified against the filesystem.


Improvement

Incomplete sweep — the two sibling sign-in pages still present the choice as a pair

  • Location: administration/authentication/magic_link.md:7, administration/authentication/single_sign_on.md:7
  • Issue: Both intros were written when there were two sign-in methods and cross-link only each other: SSO says "If you don't use an identity provider, Magic Link is an alternative way to sign in"; Magic Link says it works "without needing to set up single sign-on". The new page correctly names both siblings, but neither sibling names GitHub. A reader who lands on Magic Link from the nav — the likely path for someone without an IdP — is told the alternatives are exhausted when they are not, and never reaches the IP allow list content that this PR exists to publish.
  • Recommendation: Add GitHub to both intros, e.g. … [Magic Link](/administration/authentication/magic_link) and [GitHub sign-in](/administration/authentication/github_login) are alternative ways to sign in. Fix this →

Suggestions

Unlinked single sign-on alongside two linked methodsgetting_started/authenticating_to_kosli.md:29. Posted inline with a suggestion.

No screenshot, unlike every sibling pageadministration/authentication/github_login.md:25-28. magic_link.md and single_sign_on.md each illustrate their steps with <Frame>. The existing images/administration/magic-link-enter-email.png already shows the Continue with GitHub button below the or divider, so the "Choose GitHub" step can reuse it with GitHub-specific alt text at no cost.


1 Improvement, 2 Suggestions, 0 Critical. Nothing here blocks the merge; the sibling-page sweep is the one worth doing before it ships, since it is what makes the new page discoverable.
· branch docs/github-sign-in-page

Comment thread administration/authentication/github_login.md Outdated
FayeSGW
FayeSGW previously approved these changes Sep 15, 2026
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@gsavage
gsavage merged commit a318ec5 into main Sep 15, 2026
6 checks passed
@gsavage
gsavage deleted the docs/github-sign-in-page branch September 15, 2026 08:43
- US: [app.us.kosli.com](https://app.us.kosli.com)

Depending on how your organization is set up, you'll sign in with single sign-on, [Magic Link](/administration/authentication/magic_link) or GitHub.
Depending on how your organization is set up, you'll sign in with single sign-on, [Magic Link](/administration/authentication/magic_link) or [GitHub](/administration/authentication/github_login).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that GitHub is a link, single sign-on is the only one of the three sign-in methods in this sentence left unlinked — it has a page at /administration/authentication/single_sign_on (listed further down at line 53).

Suggested change
Depending on how your organization is set up, you'll sign in with single sign-on, [Magic Link](/administration/authentication/magic_link) or [GitHub](/administration/authentication/github_login).
Depending on how your organization is set up, you'll sign in with [single sign-on](/administration/authentication/single_sign_on), [Magic Link](/administration/authentication/magic_link) or [GitHub](/administration/authentication/github_login).

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