feat: add docs for ory elements #2198
Conversation
| @@ -84,14 +84,56 @@ enterprise identity providers. It’s modular, supports your preferred database, | |||
| data and privacy. Built for flexibility and scale, Ory Polis handles as many tenants and identity providers as your business | |||
| demands. If you're delivering enterprise-grade SaaS and need SSO that just works, Ory Polis is the missing link. | |||
|
|
|||
| ## Ory Elements | |||
|
|
|||
|  | |||
| ## All of Ory Open Source | ||
|
|
||
|  | ||
|
|
||
| ```mdx-code-block |
There was a problem hiding this comment.
Love this! In a follow up I think we could move this to the top.
There was a problem hiding this comment.
I forgot I put this in here. It's a ChatGPT'd version of the image above. But Mermaid is much easier to update. We just need to style it some more.
docs/elements/index.mdx
Outdated
| Related docs: | ||
|
|
||
| - [account-experience](../account-experience/index.mdx) |
There was a problem hiding this comment.
Nice idea (ideally docusaurus would support this with metadata?) but since we don't do this anywhere else I'm not sure if we should keep this.
There was a problem hiding this comment.
afaict docusaurus doesn't support it directly.
but they support "tags" and custom components.
So we can add a custom component that links to other related docs through the tags relatively easy.
the biggest hurdle would be to add tags to all documents - but we can probably use an LLM for this?
There was a problem hiding this comment.
It was more of a to-do list for myself, and we need to rework that doc anyway. Would be good to establish this pattern, though. Maybe LLMs can.
docs/elements/guides/02_theming.mdx
Outdated
| your application. Here is an example of how to create a custom theme: | ||
|
|
||
| ```css title="theme.css" | ||
| :root { |
There was a problem hiding this comment.
- Missing variables
- Maybe link to somewhere where the variables are explained?
There was a problem hiding this comment.
Yea, I am still working through getting a description for each variable. And cleaning up unused ones.
| @@ -0,0 +1,179 @@ | |||
| --- | |||
|
|
||
| ## Project configuration | ||
|
|
||
| The `project` configuration is used to configure the overall behavior of the Ory Elements UI components. It includes settings such |
There was a problem hiding this comment.
This will soon / now be loaded by the API right?
There was a problem hiding this comment.
Yea, that's the idea. Though I am not actually sure how to implement this, right now. In Next.js you'd want to fetch it on the server side and pass to Ory Elements, but in plain react it would need to be fetched by the client. Going to have to think about it a bit more, I fear.
| are available at the correct paths, such as `/self-service/login`, `/self-service/registration`, etc. on the same origin as your | ||
| application. This is the default behavior when using Ory Elements in a Next.js application with the Ory middleware. | ||
|
|
||
| :::caution |
There was a problem hiding this comment.
I think we should cover this in a "From dev to production" and / or "Hosting on Vercel" guide instead. There we can explain the nextjs middleware and how it works with vercel preview deployments and then how to configure it when going to prod.
There was a problem hiding this comment.
Maybe. But we need to explain this in a little detail here, too. I'd just look at the configuration page, and expect it to cover all facets of the configuration. I'll think about the going to prod guide a bit more.
They definitely can be, and should be. I think that needs to happen on release. And, very important: through a PR in the docs repo. Otherwise, we won't notice broken links. |
docs/elements/index.mdx
Outdated
| Related docs: | ||
|
|
||
| - [account-experience](../account-experience/index.mdx) |
There was a problem hiding this comment.
afaict docusaurus doesn't support it directly.
but they support "tags" and custom components.
So we can add a custom component that links to other related docs through the tags relatively easy.
the biggest hurdle would be to add tags to all documents - but we can probably use an LLM for this?
Co-authored-by: Vincent <[email protected]> Co-authored-by: hackerman <[email protected]>
Related Issue or Design Document
Checklist
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.
Further comments