Tsallake zuwa babban abun ciki
← Back to home
Clone & Contribute

Contribute via GitHub

Fork the repository, make your changes locally with any editor, and submit a Pull Request. Full control, works offline, no account permissions needed beyond a GitHub login.

Prerequisites

Git

Install from git-scm.com. Verify with git --version.

Node.js ≥ 18

Install from nodejs.org. Verify with node --version.

GitHub account

Free at github.com/join. You'll use it to fork and submit a Pull Request.

Step-by-step

01

Fork the repository

Go to github.com/warakacommunity/AfriPlaybook and click Fork (top-right corner). This creates your own copy under your GitHub account.

02

Clone your fork locally

Replace YOUR-USERNAME with your GitHub username:

git clone https://github.com/YOUR-USERNAME/AfriPlaybook.git
cd AfriPlaybook
03

Create a feature branch

Never commit directly to main. Create a descriptive branch for your contribution:

git checkout -b add/your-chapter-name
04

Install dependencies and preview

Install packages, then start the local dev server. The site will be live at http://localhost:3000 and will hot-reload as you edit.

npm install
npm start
05

Make your changes

Playbook chapters live in the docs/ folder as Markdown (.md) files. Translations go in i18n/<lang>/docusaurus-plugin-content-docs/current/. Follow the contributor guidelines for frontmatter, structure, and style conventions.

06

Commit and push

Stage your changes, write a clear commit message, and push to your fork:

git add .
git commit -m "docs: add chapter on <topic>"
git push origin add/your-chapter-name
07

Open a Pull Request

GitHub will show a banner prompting you to open a PR. Click Compare & pull request, fill in the description template, and submit. A maintainer will review and respond within a few days.

Tips for a smooth review

  • Keep PRs focused — one chapter or fix per PR makes review faster.
  • Run npm run build locally before pushing to catch broken links and MDX errors.
  • Check existing chapters for frontmatter conventions (title, description, sidebar_position).
  • For large additions, open a GitHub Discussion first to align on scope.
  • Translations must mirror the English source structure exactly.

Prefer to edit without cloning?

Use the Online editor — authenticate with GitHub and edit or translate any page directly in your browser.