|
| 1 | +# Contributing to the docs |
| 2 | + |
| 3 | +We love that you're becoming a contributor to Tangle! This guide will walk you through the steps to propose changes to the official docs. |
| 4 | + |
| 5 | +> **Note:** The easiest way to contribute is forking the repository, and using the editor on GitHub. For larger changes, continue to the steps below. |
| 6 | +> |
| 7 | +> Ready to propose your changes? See [Creating a pull request from a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). |
| 8 | +
|
| 9 | +## Step 1 - Pull the code |
| 10 | + |
| 11 | +1. [Fork the `website` repository on GitHub](https://github.com/TangleML/website/fork). |
| 12 | +2. Clone your forked repository. |
| 13 | + |
| 14 | +## Step 2 - Run the docs locally |
| 15 | + |
| 16 | +1. Ensure you have a compatible version of [Node](https://nodejs.org/en/download) installed (see [`package.json`](https://github.com/TangleML/website/blob/master/package.json) for requirements). |
| 17 | + - Running `node -v` will reveal your current version, or an error if you don't have node installed. |
| 18 | +2. Run `npm install`. |
| 19 | +3. Run `npm run start`. |
| 20 | + |
| 21 | +## Step 3 - View and edit the docs |
| 22 | + |
| 23 | +1. Wait for the dev server logs to read `Compiled successfully`. |
| 24 | +2. Make changes within the `/docs`, `/src`, and `/static` directories. |
| 25 | + - Our documentation is built using Docusaurus, with guides available to you [here](https://docusaurus.io/docs/next/category/guides). |
| 26 | +3. Preview changes by opening the dev server URL in your browser at [http://localhost:3000](http://localhost:3000). |
| 27 | + |
| 28 | +## Step 4 - Submit your change for review |
| 29 | + |
| 30 | +1. Commit and push your changes to a branch on your fork. |
| 31 | + - Please follow this commit message format: |
| 32 | + ``` |
| 33 | + docs: Document Tangle personal preferences |
| 34 | +
|
| 35 | + **Changes** |
| 36 | +
|
| 37 | + * Adds document on personal preference settings |
| 38 | + * Adds link to document in sidebar |
| 39 | + ``` |
| 40 | + - Other prefixes are `feat` (as in feature), `refactor`, and `fix`. |
| 41 | +2. [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) from your fork into the `TangleML/website` repository. |
| 42 | +
|
0 commit comments