This repository contains the Markdown source synchronized with the BenCodez Wiki and used to publish VotingPlugin documentation to multiple surfaces.
| Surface | Purpose |
|---|---|
| wiki.bencodez.com | Primary Wiki.js documentation |
| VotingPlugin GitHub Wiki | GitHub-hosted mirror |
| wiki-backup.bencodez.com | MkDocs/GitHub Pages backup |
Changes reaching main trigger both publication workflows:
.github/workflows/mirror-to-votingplugin-wiki.ymlprepares the Markdown for GitHub Wiki and pushes it toBenCodez/VotingPlugin.wiki..github/workflows/deploy-pages.ymlstages the repository for MkDocs and deploys the backup site through GitHub Pages.
home.md— Wiki.js home content; mirrored as GitHub WikiHome.mdsidebar.md— Wiki.js/sidebar content; mirrored as_Sidebar.mdVotingPlugin/— VotingPlugin documentation pagesassets/— diagrams and other documentation assets.github/workflows/— mirror and backup deployment workflowsmkdocs.yml— GitHub Pages backup configuration
The source pages may contain Wiki.js YAML front matter and attribute-only lines
such as {.is-info}. The publication workflows prepare staged copies for their
target renderer; source pages should not be destructively converted merely to
make one mirror work.
When changing links, page names, images, or metadata, consider all three published copies. Avoid deleting established page names without leaving a replacement or migration path because external links may rely on the existing slug.
- Create a branch from
main. - Keep each pull request focused on one documentation or publication concern.
- Check configuration names, commands, API signatures, and examples against the current VotingPlugin or AdvancedCore source.
- Preserve Wiki.js front matter unless the page is newly created.
- Confirm internal links work after the GitHub Wiki and MkDocs staging steps.
- Describe whether AI assisted with a proposed change.
Repository-maintenance files such as this README are excluded from the published wiki copies.