Skip to content

test(docs-screenshots): add tenant, scope, permission and role screenshots - #174

Merged
goshacodes merged 1 commit into
mainfrom
docs/entity-registration-guides
Aug 15, 2026
Merged

test(docs-screenshots): add tenant, scope, permission and role screenshots#174
goshacodes merged 1 commit into
mainfrom
docs/entity-registration-guides

Conversation

@goshacodes

Copy link
Copy Markdown
Member

Extends the documentation screenshot generator (central-ui/tests/docs-screenshots.spec.ts) with the four entities that were missing a "How To" page: Tenant, Scope, Permission and Role.

Each gets:

  • a list-view screenshot
  • a filled-in create-form screenshot
  • an expanded-card screenshot for scopes/permissions/roles (whose list view has meaningful nested detail — claims, endpoints, permissions)

Generated PNGs are copied by hand into versola-website/public/img/docs/entities/, per the existing convention documented at the top of the spec file. Companion PR on the website side: versolauth/versola-website#.

All 15 tests in the file pass (7 pre-existing + 8 new).


Pull Request opened by Augment Code | View session

…shots

Extends the documentation screenshot generator with the four remaining
entities that didn't have a 'How To' page yet: Tenant, Scope,
Permission and Role. Each gets a list view and a filled-in create-form
capture, plus expanded-card captures for scopes/permissions/roles
whose list view has meaningful nested detail.

Generated PNGs are copied by hand into
versola-website/public/img/docs/entities/ per the existing convention
documented at the top of this file.
@goshacodes
goshacodes marked this pull request as ready for review August 15, 2026 15:13
@goshacodes
goshacodes merged commit cb7b1a8 into main Aug 15, 2026
6 checks passed
@augmentcode

augmentcode Bot commented Aug 15, 2026

Copy link
Copy Markdown
Contributor
🤖 Augment PR Summary

Summary: Extends the documentation screenshot generator for the remaining entity guides.

Changes:

  • Adds list and create-form captures for tenants, scopes, permissions, and roles.
  • Adds expanded-list captures for scopes, permissions, and roles to show nested claims, endpoints, and permissions.
  • Uses the shared mocked tenant state to populate representative entity data and form values.

Technical Notes: Screenshots continue to be written to docs-screenshots/ for manual copying into the website documentation assets.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review completed. 1 suggestion posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

await loadAdminApp(page, { path: `/?view=tenants&tenant=${tenant}`, state });

await expect(page.getByRole('heading', { name: 'Tenants', exact: true })).toBeVisible();
await shot(page, 'tenants-list');

@augmentcode augmentcode Bot Aug 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

content-header is rendered while the tenant list is still loading, so this capture can run before any tenant cards arrive and save skeleton cards rather than the intended documented list. The identical race affects the initial captures at central-ui/tests/docs-screenshots.spec.ts:269 and central-ui/tests/docs-screenshots.spec.ts:297.

Severity: medium

Other Locations
  • central-ui/tests/docs-screenshots.spec.ts:269
  • central-ui/tests/docs-screenshots.spec.ts:297

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

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.

1 participant