Repository navigation
fix(docs): use kebab-case slugs for helper page links - #5766
Merged
DenysKuchma merged 1 commit intoOct 22, 2026
Merged
Conversation
The website serves helper pages under lowercase kebab-case slugs (/helpers/web-driver, /helpers/json-response), so links like /helpers/WebDriver returned 404. Generate kebab-case helper permalinks and update hand-written links in docs, README and helper JSDoc. Anchors in helper links are lowercased to match the site's heading ids. Fixes codeceptjs#5765 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
DenysKuchma
approved these changes
Oct 22, 2026
Collaborator
|
Hi, thanks a lot for this PR, aprove |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #5765
Problem
Docs link to helper pages with PascalCase URLs (e.g.
/helpers/Playwright#makeApiRequeston https://codecept.io/playwright), which return 404. The site serves helper pages under lowercase kebab-case slugs (/helpers/playwright,/helpers/web-driver,/helpers/json-response).Changes
Bunoshfile.js: addhelperSlug()(acronym-aware:GraphQL→graph-ql,JSONResponse→json-response) and use it for all helperpermalinks.docs/*.mdandREADME.mdupdated to the slugs.lib/helper/*.jsupdated;docs/helpers/*.mdregenerated.#makeApiRequest→#makeapirequest) to match the site's heading ids.docs/playwright.md: fix the malformed[GraphQL](<(/helpers/GraphQL)>)link.Verification
npx bunosh docsreproducesdocs/helpers/byte-for-byte.Follow-up
Once this and #5764 are merged,
pluginSlugandhelperSlugcan be merged into a single function.🤖 Generated with Claude Code