📚 Voting load guides and synchronized code examples (main) - #3163
Merged
Conversation
|
Warning Review limit reachedNext included review available in 25 minutes. View limit detailsLimit details: You’ve used the included review currently available. This review ran on the open-source allowance, not this organization's plan, because the pull request author doesn't have an assigned seat. Waiting won't change this — ask an organization admin to assign them a seat, or add seats in Billing if every seat is already assigned, then retry. Review configuration: ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (18)
Comment |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new remark plugin currently produces an unstable/OS-dependent groupId and uses meta: null, both of which can cause cross-environment or downstream MDX processing issues.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR revamps and expands the developer documentation for voting load testing by introducing a new end-to-end guide (k6 + Chromium), a separate telephone/IVR load-testing guide, and a Docusaurus/MDX enhancement to keep adjacent code examples synchronized via accessible tabs.
Changes:
- Adds a custom
remark-code-tabsplugin (with tests) to convert adjacent fenced blocks annotated withgroup/tabinto synchronized DocusaurusTabs/TabItem. - Introduces new voting-load and CLI reference documentation, plus a dedicated telephone load-testing guide; removes older “Load Testing” tutorial pages/categories.
- Wires the plugin into the docs build (Docusaurus config +
prebuildtest hook) and adds minimal styling for the tab UI.
File summaries
| File | Description |
|---|---|
| docs/docusaurus/static/img/voting-load-report.png.license | Adds SPDX license metadata for the report screenshot asset. |
| docs/docusaurus/src/theme/MDXComponents/index.js | Exposes CodeTabs/CodeTab MDX components backed by Docusaurus Tabs/TabItem. |
| docs/docusaurus/src/css/custom.css | Adds styling for the synchronized code tabs container/items. |
| docs/docusaurus/README.md | Documents the group/tab fence metadata convention for synchronized examples. |
| docs/docusaurus/plugins/remark-code-tabs.test.js | Adds unit tests for the remark transform behavior and error cases. |
| docs/docusaurus/plugins/remark-code-tabs.js | Implements the remark transform that generates CodeTabs/CodeTab MDX elements. |
| docs/docusaurus/package.json | Adds prebuild script to run plugin tests before building the site. |
| docs/docusaurus/docusaurus.config.js | Registers the new remark plugin for the docs pipeline. |
| docs/docusaurus/docs/07-developers/12-ivr/telephone-load-testing-guide.md | Adds a full telephone/IVR load-testing guide. |
| docs/docusaurus/docs/07-developers/10-tutorials/02-load-testing/load_testing.md | Removes the old load-testing tutorial page. |
| docs/docusaurus/docs/07-developers/10-tutorials/02-load-testing/category.yml | Removes the old load-testing category metadata. |
| docs/docusaurus/docs/07-developers/05-voting-portal/voter-status-performance.md | Adds the new “Voting load tests” guide (k6/Chromium) including report screenshot. |
| docs/docusaurus/docs/07-developers/02-cli/voting-load-reference.md | Adds generated CLI reference for step-cli load. |
| docs/docusaurus/docs/07-developers/02-cli/02-tutorials/load-testing/load_testing.md | Removes a duplicate/older load-testing tutorial page under CLI tutorials. |
| docs/docusaurus/docs/07-developers/02-cli/02-tutorials/load-testing/category.yml | Removes the related CLI-tutorials category metadata. |
| docs/docusaurus/docs/07-developers/02-cli/02-tutorials/category.yml | Removes the higher-level “Tutorials” category metadata for that subtree. |
| docs/docusaurus/docs/07-developers/02-cli/01-cli_cli.md | Replaces placeholder CLI page with build/authentication/setup guidance and links into new docs. |
| .coderabbit.yaml | Adds/updates CodeRabbit auto-review configuration for selected base branches. |
Review details
- Files reviewed: 18/20 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+27
to
+30
| const document = path.relative( | ||
| path.resolve(__dirname, ".."), | ||
| file.path || "document", | ||
| ); |
Comment on lines
+69
to
+71
| element("CodeTab", { value: info.tab, label: info.tab }, [ | ||
| { ...code, meta: info.rest || null }, | ||
| ]), |
|
Findeton
approved these changes
Sep 8, 2026
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
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.
Parent issue: https://github.com/sequentech/meta/issues/12767
One complete k6/Chromium guide covers setup, workload sizing, local/Docker/Kubernetes workers, reports and troubleshooting. Includes synchronized engine examples, CLI reference, a real report screenshot and a separate telephone guide.
Validation: Docusaurus build, Markdown-transform tests and Chromium checks for synchronized tabs, persistence, keyboard navigation, mobile layout and report images.
Stack
Documentation