Contributing

Just like Feathers itself, all of the documentation is open source and available to edit on GitHub. If you see something that you can contribute, we would LOVE a pull request with your edits! To make this easy you can click the “Edit this page” link at the top of the web docs.

The docs are all written in GitHub Flavored Markdown. If you’ve used GitHub, it’s pretty likely you’ve encountered it before. You can become a pro in a few minutes by reading their GFM Documentation page.

Organizing Files

You’ll notice that the GitHub Repo is organized in a nice logical folder structure. The first file in each chapter is named as a description of the entire chapter’s topic. For example, the content related to databases is located in api/databases/.

Some of the chapters are split into multiple sections to help break up the content and make it easier to digest. You can easily see how chapters are laid out by looking at the SUMMARY.md file. This convention helps keep chapters together in the file system and easy to view either directly on github or gitbook.

Table of Contents

You’ll find the table of contents in the SUMMARY.md file. It’s a nested list of markdown links. You can link to a file simply by putting the filename (including the extension) inside the link target.

Introduction Page

This is the root README.md file. It’s intent is to give the reader an elevator pitch of what Feathers is and why we think it is useful.

Send a Pull Request

So that’s it. You make your edits, keep your files and the Table of Contents organized, and send us a pull request.

Enjoy the Offline Docs

Moments after your edits are merged, they will be automatically published to the web, as a downloadable PDF, .mobi file (Kindle compatible), and ePub file (iBooks compatible).

Share

We take pride in having great documentation and we are very appreciative of any help we can get. Please, let the world know you’ve contributed to the Feathers Book or give @FeathersJS a shout out on Twitter to let others know about your changes.