feat: identities getting started #2103

christiannwamba · 2025-04-08T06:26:42Z

Checklist

I have read the contributing guidelines and signed the CLA.
I have referenced an issue containing the design document if my change introduces a new feature.
I have read the security policy.
I confirm that this pull request does not address a security vulnerability.
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
I have added tests that prove my fix is effective or that my feature works.
I have added the necessary documentation within the code base (if appropriate).

Further comments

christiannwamba · 2025-04-10T06:29:04Z

christiannwamba · 2025-04-10T10:23:03Z

aeneasr

Structurally it's going in the right direction, but I think we need a bit more work on the content side!

docs/identities/get-started/setup.mdx

docs/identities/_assets.zip

docs/identities/get-started/index.mdx

docs/identities/get-started/setup.mdx

docs/identities/get-started/sign-in.mdx

docs/identities/get-started/index.mdx

docs/identities/get-started/account-recovery.mdx

docs/identities/get-started/mfa.mdx

docs/identities/get-started/passwordless.mdx

piotrmsc · 2025-04-15T07:29:58Z

docs/identities/get-started/sign-in.mdx

+
+```tsx
+export default function Page() {
+  const [session, setSession] = useState<Session | null>(null)


I am following the guide "step by step" and it does not explain on which port my app should run, which modules beside ory client I should use and the config code example is broken.

I am using latest preview deployment https://docs-gqucrqdpp-ory.vercel.app/docs/identities/get-started/setup#3-configure-the-sdk

I am making some assumptions about the reader. If a reader is on this pages, they have a language/framework of choice which means they are familiar with that language/framework. Providing every context will bloat the example snippets. The only context that is required is the ory SDK stuff but language specific context are assumed about the reader.

Added a "What you'll need" section to set some expectation for the reader

piotrmsc · 2025-04-15T07:33:16Z

Following again blindly "step by step" : When I try logout I am getting 404 after logout call as well, in ory tunnel I see calls and redirects but in the end I end up with 404 from CF blocking rule, do I need to configure something extra?

piotrmsc · 2025-04-15T07:35:27Z

docs/identities/get-started/_common/code-examples/js/session/check-session.js

+const requireAuth = async (req, res, next) => {
+  try {
+    const session = await ory.toSession({ cookie: req.header("cookie") })
+    req.session = session
+    next()
+  } catch (error) {
+    res.redirect(`${process.env.ORY_SDK_URL}/self-service/login/browser`)
+  }
+}
+
+app.get("/", requireAuth, (req, res) => {
+  res.json(req.session.identity.traits) // { email: '[email protected]' }
+})


can this be re-used already in sign in /sign up example? you are also partially doing it in / handler for registration.

The sign and sign up sections are intentionally flat so the reader can focus on a stripped down version of the code and just care about the core. Then they progress to higher levels of abstraction which is why I created the requireAuth middleware for protecting routes

piotrmsc · 2025-04-15T07:38:32Z

docs/identities/get-started/account-recovery.mdx

+To start the account recovery flow, send the user to the recovery page:
+
+```html
+<a href="$ORY_SDK_URL/self-service/recovery/browser">Recover your account</a>


if we have node example shouldn't this be covered also with code example for consistency ?

I agree. This should be wrapped in a code example

Decided to leave this as is since it's straightforward. But happy to reconsider if it hurts the reader's experience

vinckr

Huge PR!
I think we are very close to getting this one perfect and will be a great basis for getting started!

I did not test all the code examples but the ones I tested were straightforward enough - maybe you can create an issue to add automated tests for these examples later on? I think long-term would be good avoid drift.

I also noticed you added some neat new(?) components, love them!

Please track adding a "custom components" section to the README in a followup issue - so others know how to use these components? It is mostly clear from this example, but it could save us some time in the future - you don't need to do it in this PR though.

All in all I had mostly some minor style issues, nothing major. Let me know where you had followup questions, once we have this resolved let's

docs/identities/get-started/_common/flow-overview.mdx

vinckr · 2025-04-16T19:32:50Z

docs/identities/get-started/account-recovery.mdx

+<TabItem value="console">
+```
+
+**Enable and configure account recovery**


Suggested change

**Enable and configure account recovery**

#### Enable and configure account recovery

Please "Use bold only when writing about user interface (UI) elements." - see styleguide

Use h4 if you want a section that is "bolded" but does not show up in the TOC.

This was intentional because it messes up the table of content. Tabs repeat header content when those contents are repeated they are double in the table of content on the side bar

vinckr · 2025-04-16T19:33:28Z

docs/identities/get-started/account-recovery.mdx

+</BrowserWindow>
+```
+
+**Recovery strategy**


Suggested change

**Recovery strategy**

#### Recovery strategy

See above

docs/identities/get-started/account-recovery.mdx

vinckr · 2025-04-16T19:34:15Z

docs/identities/get-started/account-recovery.mdx

+<TabItem value="cli">
+```
+
+**Download your current configuration**


Suggested change

**Download your current configuration**

#### Download your current configuration

See above

vinckr · 2025-04-16T19:56:29Z

docs/identities/get-started/social-sign-in.mdx

+</BrowserWindow>
+```
+
+**Adding a social provider**


Suggested change

**Adding a social provider**

#### Add a social provider

vinckr · 2025-04-16T19:56:42Z

docs/identities/get-started/social-sign-in.mdx

+
+Ory offers pre-configured options for popular providers. Check our provider list [here](/docs/kratos/social-signin/overview).
+
+**Configuring your provider**


Suggested change

**Configuring your provider**

#### Configure your provider

vinckr · 2025-04-16T20:01:06Z

docs/identities/get-started/account-recovery.mdx

+</Tabs>
+```
+
+## Initiating account recovery


Suggested change

## Initiating account recovery

## Initiate account recovery

docs/identities/get-started/account-recovery.mdx

docs/identities/get-started/mfa.mdx

piotrmsc · 2025-04-17T06:15:31Z

Huge PR! I think we are very close to getting this one perfect and will be a great basis for getting started!

I did not test all the code examples but the ones I tested were straightforward enough - maybe you can create an issue to add automated tests for these examples later on? I think long-term would be good avoid drift.

I agree with the idea of tests,however, to have them running and testing the code examples they would need to be code-complete and currently are not (see my previous review comments on them). Which for me would make sense to have getting-started code examples as code complete with option to collapse lines of code that are not ory-specific.

@christiannwamba what's your take on it?

Co-authored-by: Vincent <[email protected]>

christiannwamba added 2 commits April 8, 2025 07:25

feat: identities getting started

7686156

chore: format

7ae7fd8

christiannwamba requested review from vinckr, aeneasr, zepatrik and piotrmsc as code owners April 8, 2025 06:26

github-actions bot added the Needs Triage label Apr 8, 2025

ory-bot assigned christiannwamba Apr 8, 2025

christiannwamba marked this pull request as draft April 8, 2025 06:27

vercel bot deployed to Preview April 8, 2025 06:27 View deployment

github-actions bot removed the Needs Triage label Apr 8, 2025

docs: update identities get-started

827fa9b

vercel bot had a problem deploying to Preview April 10, 2025 06:18 Failure

chore: format

7c4cf53

vercel bot deployed to Preview April 10, 2025 06:24 View deployment

docs: refine based on feedback

f851cea

vercel bot had a problem deploying to Preview April 10, 2025 15:10 Failure

docs: fix image cut offs

9af2ee8

vercel bot had a problem deploying to Preview April 10, 2025 15:29 Failure

chore: format

4935ce5

vercel bot deployed to Preview April 10, 2025 15:34 View deployment

christiannwamba added 2 commits April 11, 2025 12:18

docs: test js example

7546b46

chore: format

701a16e

vercel bot deployed to Preview April 11, 2025 11:26 View deployment

christiannwamba added 2 commits April 14, 2025 07:08

docs: test all walkthroughs and refacot examples

558ffa4

chore: format

a2be8fd

vercel bot deployed to Preview April 14, 2025 06:11 View deployment

christiannwamba marked this pull request as ready for review April 14, 2025 06:13

chore: use consistent titles

5012ca8

vercel bot deployed to Preview April 14, 2025 06:31 View deployment

aeneasr requested changes Apr 14, 2025

View reviewed changes

christiannwamba added 2 commits April 14, 2025 17:12

chore: resolve feedback

e474483

chore: format

09117a4

vercel bot deployed to Preview April 14, 2025 16:15 View deployment

piotrmsc reviewed Apr 15, 2025

View reviewed changes

docs: pre-requisites and user assumptions

59e7a08

vercel bot deployed to Preview April 16, 2025 05:12 View deployment

vinckr requested changes Apr 16, 2025

View reviewed changes

chore: remove secure

471e4d7

Co-authored-by: Vincent <[email protected]>

vercel bot deployed to Preview April 17, 2025 12:31 View deployment

christiannwamba and others added 3 commits April 17, 2025 13:32

chore: remove bold from texts

e66305a

Co-authored-by: Vincent <[email protected]>

chore: highlight technical tokens

87bc9df

Co-authored-by: Vincent <[email protected]>

chore: remove unnecessary word

57d798c

Co-authored-by: Vincent <[email protected]>

vercel bot deployed to Preview April 17, 2025 12:35 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: identities getting started #2103

feat: identities getting started #2103

christiannwamba commented Apr 8, 2025 •

edited

Loading

christiannwamba commented Apr 10, 2025 •

edited

Loading

christiannwamba commented Apr 10, 2025 •

edited

Loading

aeneasr left a comment

piotrmsc Apr 15, 2025

piotrmsc Apr 15, 2025

christiannwamba Apr 15, 2025

christiannwamba Apr 16, 2025

piotrmsc commented Apr 15, 2025 •

edited

Loading

piotrmsc Apr 15, 2025 •

edited

Loading

christiannwamba Apr 16, 2025

piotrmsc Apr 15, 2025

christiannwamba Apr 15, 2025

christiannwamba Apr 16, 2025

vinckr left a comment

vinckr Apr 16, 2025

christiannwamba Apr 17, 2025

vinckr Apr 16, 2025

vinckr Apr 16, 2025

vinckr Apr 16, 2025

vinckr Apr 16, 2025

vinckr Apr 16, 2025

piotrmsc commented Apr 17, 2025

	Enable and configure account recovery
	#### Enable and configure account recovery

	Download your current configuration
	#### Download your current configuration


		Ory offers pre-configured options for popular providers. Check our provider list [here](/docs/kratos/social-signin/overview).

		Configuring your provider

feat: identities getting started #2103

Are you sure you want to change the base?

feat: identities getting started #2103

Conversation

christiannwamba commented Apr 8, 2025 • edited Loading

Related Issue or Design Document

Checklist

Further comments

christiannwamba commented Apr 10, 2025 • edited Loading

christiannwamba commented Apr 10, 2025 • edited Loading

aeneasr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

piotrmsc commented Apr 15, 2025 • edited Loading

piotrmsc Apr 15, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vinckr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

piotrmsc commented Apr 17, 2025

christiannwamba commented Apr 8, 2025 •

edited

Loading

christiannwamba commented Apr 10, 2025 •

edited

Loading

christiannwamba commented Apr 10, 2025 •

edited

Loading

piotrmsc commented Apr 15, 2025 •

edited

Loading

piotrmsc Apr 15, 2025 •

edited

Loading