Add blank authentication and user provisioning pages - #382
Add blank authentication and user provisioning pages#382mintlify[bot] wants to merge 15 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @FayeSGW's task in 1m 56s —— View job Doc reviewReviewed at branch head ( Four findings posted inline:
Two smaller points, not worth inline comments:
Links — all six internal targets in the changed files resolve ( 3 Improvements, 1 Suggestion, 0 Critical. Nothing here blocks the merge; the two |
| "administration/authentication/api_authentication_methods", | ||
| "administration/authentication/service_accounts", | ||
| "administration/authentication/api_key_rotation" | ||
| "administration/authentication/api_key_rotation", | ||
| "administration/authentication/single_sign_on", | ||
| "administration/authentication/magic_link" | ||
| ] |
There was a problem hiding this comment.
Suggestion — ordering. The two new pages cover human sign-in, but they're appended after three machine/API-auth pages, so the group now reads API-first and buries the topic most admins land here looking for. Consider leading with human auth:
| "administration/authentication/api_authentication_methods", | |
| "administration/authentication/service_accounts", | |
| "administration/authentication/api_key_rotation" | |
| "administration/authentication/api_key_rotation", | |
| "administration/authentication/single_sign_on", | |
| "administration/authentication/magic_link" | |
| ] | |
| "pages": [ | |
| "administration/authentication/single_sign_on", | |
| "administration/authentication/magic_link", | |
| "administration/authentication/api_authentication_methods", | |
| "administration/authentication/service_accounts", | |
| "administration/authentication/api_key_rotation" | |
| ] |
Non-blocking — happy to leave as-is if you'd rather not reshuffle existing entries while the pages are still empty.
Fill in the Single Sign On page with the setup-wizard screenshots and bring it into line with the conventions in CLAUDE.md. The three <<insert ... image>> placeholders become <Frame> embeds, matching the in-house style used elsewhere in the repo. The four numbered step headings become a <Steps>/<Step> block, as CLAUDE.md asks for sequential procedures and as the sibling service accounts page already does. The doc's own step numbering is intentionally independent of the wizard's page count, which varies with what the user enters. Also fix a duplicated word in the "Enabling Single Sign On" heading, two British spellings (one of which, "organisation", is an error-level Vale violation), sentence-case the step titles, bold the UI labels, and replace curly apostrophes and a hyphen-as-dash. The six authentication screenshots move into images/administration/, since CLAUDE.md asks for images to live in an appropriate subdirectory rather than the images/ root.
| <Frame><img src="/images/administration/magic-link-enter-email.png" alt="Kosli sign-in page with an email address entered and the Continue with SSO button" /></Frame> | ||
| </Step> | ||
| <Step> | ||
| Kosli then sends you an email containing the link and ask you to check your inbox |
There was a problem hiding this comment.
Improvement — subject–verb disagreement and a missing full stop. "Kosli then sends you an email … and ask you to check your inbox" — should be "asks", and the sentence doesn't terminate.
| Kosli then sends you an email containing the link and ask you to check your inbox | |
| Kosli then sends you an email containing the link and asks you to check your inbox. |
| icon: "key" | ||
| --- | ||
|
|
||
| Kosli supports signing-in using your identity provider, via Single Sign On (SSO). |
There was a problem hiding this comment.
Improvement — the two pages added in this PR name the feature differently. magic_link.md:7 links here as "[single sign-on]", so a reader clicks a link labelled single sign-on and lands on a page headed Single Sign On. The magic link page has the same split internally: Magic Link in the title and line 7, magic link in both ## headings and the body.
Pick one form per feature and use it in the title, headings and prose. Sentence case ("Single sign-on", "Magic link") is what CLAUDE.md asks for and what every sibling in this group uses (api_authentication_methods.md, service_accounts.md, api_key_rotation.md — all unquoted sentence case), and hyphenated "single sign-on" is the standard rendering.
There's also no route from here back to magic link, though this page is where an admin evaluating sign-in options will land first.
Fill out the automated user provisioning page with setup, timeliness, existing-user, and IdP role-mapping sections, plus the SCIM setup wizard and group role mapping screenshots. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
| <Frame><img src="/images/administration/magic-link-enter-email.png" alt="Kosli sign-in page with an email address entered and the Continue with SSO button" /></Frame> | ||
| </Step> | ||
| <Step> | ||
| Kosli then sends you an email containing the link and ask you to check your inbox |
There was a problem hiding this comment.
Improvement — subject–verb disagreement, and the sentence doesn't terminate. "Kosli then sends you an email … and ask you" should be "asks", and there's no full stop.
| Kosli then sends you an email containing the link and ask you to check your inbox | |
| Kosli then sends you an email containing the link and asks you to check your inbox. |
Link the SCIM provisioning page from the OIDC/SAML choice in the SSO setup wizard, and note on the roles page that SCIM-provisioned users' roles cannot be changed in Kosli. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
| <Frame><img src="/images/administration/magic-link-enter-email.png" alt="Kosli sign-in page with an email address entered and the Continue with SSO button" /></Frame> | ||
| </Step> | ||
| <Step> | ||
| Kosli then sends you an email containing the link and ask you to check your inbox |
There was a problem hiding this comment.
Improvement — subject–verb disagreement, and the sentence has no full stop. "Kosli then sends you an email … and ask you to check your inbox" should be "asks". This is the only one of the three <Step> bodies on the page that doesn't terminate.
| Kosli then sends you an email containing the link and ask you to check your inbox | |
| Kosli then sends you an email containing the link and asks you to check your inbox. |
| icon: "wand-magic-sparkles" | ||
| --- | ||
|
|
||
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
There was a problem hiding this comment.
Improvement — "setup" is the noun; the verb is "set up".
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. | |
| Magic Link is a way of signing into Kosli without needing to set up [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
| @@ -0,0 +1,47 @@ | |||
| --- | |||
| title: Single Sign On | |||
There was a problem hiding this comment.
Improvement — the two pages added here still name their own features three different ways.
- This page:
Single Sign Onin the title, headings and body. magic_link.md:7links here as "[single sign-on]", andautomated_user_provisioning.md:16links here as "[single sign-on]" too — so both inbound links are labelled differently from the page they land on.magic_link.mdis split against itself:Magic Linkin the title and line 7,magic linkin both##headings and lines 11/17.
CLAUDE.md asks for sentence case in headings, and every sibling in this group uses an unquoted sentence-case title (api_authentication_methods.md, service_accounts.md:2, api_key_rotation.md). "Single sign-on" is also the conventional rendering.
| title: Single Sign On | |
| title: Single sign-on |
If you go with this, the ## Enabling Single Sign On heading (line 9) and line 7 need the same treatment, as does Magic Link → Magic link on the magic link page — pick one form per feature and use it in the title, headings, prose and link text.
|
|
||
| ## Using magic link | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
Suggestion — the <Step> elements have no title, unlike every other <Steps> block in administration/. single_sign_on.md:20-44 in this same PR titles all four of its steps, and service_accounts.md:15-28 titles all four of its. Without titles these render as bare numbers, so a reader scanning the page gets no summary of the flow.
| <Steps> | |
| <Steps> | |
| <Step> |
The other two would be something like title="Check your inbox" and title="Click the link".
State on both pages that a SCIM-provisioned user's roles cannot be changed in Kosli, replacing the override-on-sync wording. Give the group-mapping steps their own heading with the screenshot inline, and move the callouts clear of both procedures. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
| <Frame><img src="/images/administration/magic-link-enter-email.png" alt="Kosli sign-in page with an email address entered and the Continue with SSO button" /></Frame> | ||
| </Step> | ||
| <Step> | ||
| Kosli then sends you an email containing the link and ask you to check your inbox |
There was a problem hiding this comment.
Improvement — subject–verb disagreement, and the sentence has no full stop. "Kosli then sends you an email … and ask you to check your inbox" should be "asks". This is the only one of the three <Step> bodies that doesn't terminate.
| Kosli then sends you an email containing the link and ask you to check your inbox | |
| Kosli then sends you an email containing the link and asks you to check your inbox. |
| icon: "wand-magic-sparkles" | ||
| --- | ||
|
|
||
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
There was a problem hiding this comment.
Improvement — "setup" is the noun; the verb is "set up".
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. | |
| Magic Link is a way of signing into Kosli without needing to set up [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
| title: Single Sign On | ||
| description: "Learn about configuring Single Sign On with Kosli" | ||
| icon: "key" | ||
| --- | ||
|
|
||
| Kosli supports signing-in using your identity provider, via Single Sign On (SSO). | ||
|
|
||
| ## Enabling Single Sign On |
There was a problem hiding this comment.
Improvement — the headings here are Title Case, and the two new pages name their own features inconsistently.
CLAUDE.md asks for sentence case for all headings; every sibling in this group uses an unquoted sentence-case title (api_authentication_methods.md:2 "API authentication methods", service_accounts.md:2 "Service accounts", api_key_rotation.md:2 "API key rotation"). Here the title, ## Enabling Single Sign On, and the body all use "Single Sign On".
The inconsistency is also visible to a reader following links:
magic_link.md:7andautomated_user_provisioning.md:16both link here with the text "single sign-on", so the link label never matches the page they land on.magic_link.mdis split against itself:Magic Linkin the title and lines 7/17,magic linkin both##headings and line 11.
Pick one rendering per feature and use it in the title, headings, prose and inbound link text.
| title: Single Sign On | |
| description: "Learn about configuring Single Sign On with Kosli" | |
| icon: "key" | |
| --- | |
| Kosli supports signing-in using your identity provider, via Single Sign On (SSO). | |
| ## Enabling Single Sign On | |
| title: Single sign-on | |
| description: "Learn about configuring single sign-on with Kosli." | |
| icon: "key" | |
| --- | |
| Kosli supports signing in using your identity provider, via single sign-on (SSO). | |
| ## Enabling single sign-on |
|
|
||
| ## Using magic link | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
Suggestion — these <Step> elements have no title, unlike every other <Steps> block in administration/. single_sign_on.md:20-44 in this same PR titles all four of its steps, and service_accounts.md:15-28 titles all four of its. Untitled steps render as bare numbers, so a reader scanning the page gets no summary of the flow — and the two pages added together are inconsistent with each other.
| <Steps> | |
| <Steps> | |
| <Step> |
The other two would be something like title="Check your inbox" and title="Click the link".
Adds three placeholder pages for content to be written manually:
administration/authentication/single_sign_on.md— "Single Sign On", under Authentication & accessadministration/authentication/magic_link.md— "Magic Link", under Authentication & accessadministration/managing_users/automated_user_provisioning.md— "Automated User Provisioning", under Users & rolesEach page contains only its title. Extracted from #380 so this authentication work can proceed independently of the Kosli Capture page.
Generated by Mintlify Agent.
Requested by: graham@kosli.com via Slack
Mintlify session: slack_1782915660.508229_D0AM66349C1