Skip to content

Contributing after the Codec Wiki migration

currentMigrated from docs/contribution-guide.mdx at 37c3317fd058; modified for Encode Wiki · CC BY-SA 4.0

The migrated Codec Wiki instructions used a different GitHub repository, Node 18, Yarn, Docusaurus, and a deployment branch. Those steps do not apply to Encode Wiki.

Use the Encode Wiki repository and its CONTRIBUTING.md as the authoritative workflow. This project uses Astro/Starlight and pnpm; install the Node and package-manager versions declared in the checkout’s package.json.

  1. Read the checkout’s repository instructions and choose the merge-request target specified for the task. Ordinary integration uses master; older refresh-branch names are not a standing requirement for every contribution.
  2. Edit canonical pages under src/content/docs or src/content/articles. Preserve attribution, licenses, origin metadata, and modification notices for migrated material.
  3. Cite primary sources, identify versions for commands, and describe uncertainty and request review before publication.
  4. Run pnpm verify, inspect the rendered page, and open a merge request. An independent approving reviewer is required for the refresh. Production promotion is a separate operator action.

Do not follow the old direct-push or yarn deploy instructions. The historical guide at its migration commit remains available for provenance.