Skip to content

docs: add prompts partials documentation and examples#1318

Open
kushalshit27 wants to merge 1 commit intomasterfrom
chore-prompt-partials-example
Open

docs: add prompts partials documentation and examples#1318
kushalshit27 wants to merge 1 commit intomasterfrom
chore-prompt-partials-example

Conversation

@kushalshit27
Copy link
Contributor

🔧 Changes

Documents the partials feature under the prompts resource, which allows injecting custom HTML (via Liquid templates) into specific insertion points of a prompt screen.

Examples

YAML format

Inline Liquid content in tenant.yaml:

prompts:
  identifier_first: false
  universal_login_experience: new
  webauthn_platform_first_factor: false
  partials:
    login:
      login:
        form-content-start: |
          <div class="login-notice">
            Welcome back! Please log in to continue.
          </div>
    signup:
      signup:
        form-content-start: |
          <div class="signup-notice">
            Create your account to get started.
          </div>
        form-content-end: |
          <p class="signup-terms">
            By signing up, you agree to our <a href="/terms">Terms of Service</a>.
          </p>

Directory format

Folder structure:

./prompts/
    /partials
        /login
            /login
                /form-content-start.liquid
        /signup
            /signup
                /form-content-start.liquid
                /form-content-end.liquid
    /partials.json

partials.json manifest (paths relative to prompts/):

{
  "login": [
    {
      "login": [
        {
          "name": "form-content-start",
          "template": "partials/login/login/form-content-start.liquid"
        }
      ]
    }
  ],
  "signup": [
    {
      "signup": [
        {
          "name": "form-content-start",
          "template": "partials/signup/signup/form-content-start.liquid"
        },
        {
          "name": "form-content-end",
          "template": "partials/signup/signup/form-content-end.liquid"
        }
      ]
    }
  ]
}

🔬 Testing

  • No source-code changes were made in this PR

📝 Checklist

  • All new/changed/fixed functionality is covered by tests (or N/A)
  • I have added documentation for all new/changed functionality (or N/A)

- examples/yaml/tenant.yaml: Introduce partials for login and signup with custom HTML content.
- examples/directory/prompts/partials.json: Create manifest for partials mapping.
- examples/directory/prompts/partials/login/login/form-content-start.liquid: Add custom HTML for login form start.
- examples/directory/prompts/partials/signup/signup/form-content-start.liquid: Add custom HTML for signup form start.
- examples/directory/prompts/partials/signup/signup/form-content-end.liquid: Add custom HTML for signup form end.
@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.15%. Comparing base (3c8d3f1) to head (9cf12f4).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1318   +/-   ##
=======================================
  Coverage   80.15%   80.15%           
=======================================
  Files         152      152           
  Lines        6096     6096           
  Branches     1245     1245           
=======================================
  Hits         4886     4886           
  Misses        693      693           
  Partials      517      517           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@kushalshit27 kushalshit27 marked this pull request as ready for review March 5, 2026 06:09
@kushalshit27 kushalshit27 requested a review from a team as a code owner March 5, 2026 06:09
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