Skip to content

docs: update authorise page based on reviewer feedback - #8

Merged
nat294 merged 1 commit into
developfrom
docs/fix-authorise
Feb 17, 2026
Merged

docs: update authorise page based on reviewer feedback#8
nat294 merged 1 commit into
developfrom
docs/fix-authorise

Conversation

@nat294

@nat294 nat294 commented Feb 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fix H6 headings appearing smaller than bold text by adding .markdown h6 { font-size: 1rem } to custom.css
  • Add missing "Guardrail Type" heading before the type-specific sections
  • Restructure guardrail sections to eliminate repeated content — shared configuration (Toggles, Activity Type, Fields to Check, Timeout, Retry) is now documented once.
  • Add error handling callout in Behavioral Rules linking to the SDK Error Handling page.
  • Add wizard completion tip warning users to fill all required fields before clicking Create Rule.

@nat294
nat294 requested a review from tonyopenbox February 17, 2026 06:01
@vercel

vercel Bot commented Feb 17, 2026

Copy link
Copy Markdown

@nat294 must be a member of the Platform team on Vercel to deploy.
- Click here to add @nat294 to the team.
- If you initiated this build, request access.
- If you're already a member of the Platform team, make sure that your Vercel account is connected to your GitHub account.

Learn more about collaboration on Vercel and other options here.

@ash-krnl ash-krnl left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good to me, just make sure the toggles are working on docausaurus

Behavioral rules are created through a 5-step wizard.

:::tip
Complete all required fields in each wizard step before proceeding. Skipping a step and clicking **Create Rule** will result in an error.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Great!

I think we also need to pass this back to the dev team to add validation to each step to provide a more useful error message.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, I will inform them in backlog to maybe add useful message on UI for users but anyway, thanks Tony :D

@nat294

nat294 commented Feb 17, 2026

Copy link
Copy Markdown
Contributor Author

Looks good to me, just make sure the toggles are working on docausaurus

Thanks @ash-krnl , I tested locally with npm start and it seems work on the side.

@nat294
nat294 merged commit e6520dc into develop Feb 17, 2026
1 check failed
@tonyopenbox
tonyopenbox deleted the docs/fix-authorise branch February 27, 2026 08:31
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.

3 participants