Skip to content

Contribute to the Jabali docs

These docs are open source and community-maintained. Anyone can suggest a fix or a new page, and a Jabali maintainer reviews every change before it goes live.

  1. Click Edit page at the bottom of the page you want to change. You’ll need a free GitHub account.
  2. GitHub asks you to fork the repository. Click Fork this repository.
  3. Make your edits in the browser. Pages are written in Markdown.
  4. Click Commit changes…, describe what you changed, then click Propose changes.
  5. Click Create pull request.

A maintainer will review your change, may suggest edits, and merges it when it’s ready. The site updates automatically a few minutes after merge.

Not sure how to fix it? Open an issue describing what’s wrong or missing.

  • Start with the answer. Open each page and section with a one- or two-sentence summary of what the reader will learn or do.
  • Use clear, descriptive headings. Phrase FAQ headings as questions ending in “?”.
  • Write steps as numbered lists, one action per step, with UI labels in bold.
  • Add alt text to every image describing what the screenshot shows.
  • Use product names consistently: Jabali Studio, Jabali Web, Bali.
  • Only document released features. Don’t describe features that haven’t shipped yet.

The full contributor guide, including how to add pages and screenshots and how to preview the site locally, is in CONTRIBUTING.md on GitHub.