Here you will find all that you need to know to start contributing to Forge Wiki.

First of all, thank you for your interest in contributing to Forge Wiki. With the help from the community, documenting Forge as it continues to grow, the documentation should be developed along with it.

So this is where the community comes in to help!

Where to start?

You can find a list of issues here. When you find something you would like to work on that's an open issue, just comment on it and we will add an In Progress label.

If there's a documentation page that you would like to create, edit or remove - submit a new issue for Documentation.

Environment Setup

Forge Wiki uses GitBook for documentation.

You can contribute to the wiki by being invited into the GitBook online workspace or directly from your local environment. Follow this guide for a simple local environment setup

  • Install any code editor of your choice, VSCode is a recommended editor

  • Launch VSCode and install the Auto-Open Markdown Preview and markdownlint extensions. This will help with automatically formatting your changes and prompts for any potential errors

  • Fork and clone the Forge Wiki repository

  • Open the project in VSCode and start making your changes

Creating a new Pull Request


When you create a new pull request, we expect some requirements that need to be met before we accept the change.

  • Follow this naming convention for Pull Requests:

    • When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Advanced forge tutorial

    • When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Advanced forge tutorial

    • When updating documentation, add Update Documentation: before the title. E.g. Fix Documentation: Advanced forge tutorial

  • If your Pull Request closes an issue you need to write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number at the end of the link URL that will link your pull request to the issue, when merged will close that issue.

Community Maintainers

We are looking for community maintainers for Forge Wiki. Maintainers will be added to a special team with write permissions. These permissions consist of opening, closing, tagging, and editing issues and pull requests, create and delete non-protected branches on the docs repository. The responsibilities of a maintainer are:

Issue Organization

  • Labeling Issues: Label issues accordingly

  • Finding Duplicates: Finding and closing duplicate issues

  • Closing irrelevant/inappropriate issues: Closing issues that are no longer needed, that are not relevant to the wiki, and/or don't follow the issues guidelines

  • Doing first-level contact: Getting more information on the issues (like asking for clarification) and closing them if they aren't relevant or if a question made by the maintainer wasn't answered in 7 days.

Help with Contribution

  • Help Manage Pull Requests: Help the author of the pull request with any problems (like tests failing due to markdown problems on the pull request)

  • Contributing! Create pull requests to help maintain the wiki

Markdown formatting

Markdown formatting is the supported method for documentation. Learn more about Markdown itself, by visiting Common Mark.

Also see Markdown Style Guide

Last updated