mirror of
https://github.com/supabase/supabase.git
synced 2026-09-10 20:10:31 +08:00
bdd4b8d369
## What kind of change does this PR introduce? bug fix (accessibility) + test coverage ## What is the current behavior? the guides sidebar renders invalid list markup: group headers and dividers sit directly under the root `ul`, and accordion links render as `li` elements without an owning list fixes [DOCS-1279](https://linear.app/supabase/issue/DOCS-1279/guides-sidebar-put-li-elements-directly-in-the-ul) ## What is the new behavior? - sidebar renders a semantic hierarchy: every `ul` has only `li` children, every `li` has an immediate list parent, and the menu header sits outside the item list. pure markup change, - docs e2e scans the guide navigation separately from the article and blocks the `list` and `listitem` axe rules there against sample pages that include different usages (flat links, grouped links, nested accordion) ## How to test? run the docs dev server, then the scoped a11y suite: ```bash pnpm dev:docs pnpm e2e:docs:a11y ``` ## Follow up visuals and behavior are unchanged here but better parity between guide/reference is handled in the stacked pr <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Improved documentation navigation rendering for nested guide items, active states, and disabled entries. * Ensured navigation groups and child links use valid, testable list structures. * **Tests** * Added coverage verifying that guide navigation changes run the appropriate documentation pages. * Confirmed unrelated documentation changes can be skipped by the end-to-end workflow. * **Chores** * Updated documentation test scope detection to include guide navigation changes. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
32 lines
888 B
TypeScript
32 lines
888 B
TypeScript
import assert from 'node:assert/strict'
|
|
import test from 'node:test'
|
|
import { fileURLToPath } from 'node:url'
|
|
|
|
import {
|
|
GUIDE_LIST_COMPONENT,
|
|
GUIDE_LIST_COMPONENT_PAGES,
|
|
resolveDocsScope,
|
|
} from './resolve-docs-scope.ts'
|
|
|
|
const repoRoot = fileURLToPath(new URL('../../..', import.meta.url))
|
|
|
|
test('maps a guide list component change to its sample pages', async () => {
|
|
const result = await resolveDocsScope({
|
|
changedFiles: [GUIDE_LIST_COMPONENT],
|
|
repoRoot,
|
|
})
|
|
|
|
assert.deepEqual(result.pages, [...GUIDE_LIST_COMPONENT_PAGES].sort())
|
|
assert.equal(result.skip, false)
|
|
})
|
|
|
|
test('ignores unrelated docs component changes', async () => {
|
|
const result = await resolveDocsScope({
|
|
changedFiles: ['apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts'],
|
|
repoRoot,
|
|
})
|
|
|
|
assert.deepEqual(result.pages, [])
|
|
assert.equal(result.skip, true)
|
|
})
|