Links
💻

Contribute to the Docs

If you need any help to get set up, ask @mikepsinn for help in the Discussions forum. I'd be happy to respond to any questions or have a video call with you.
Make sure to adhere to the Writing Style Guide and always use Grammarly (or Language Tool if editing on Githbook) to avoid any grammatical errors.

Option 1: Edit or Comment On Gitbook

For quick, small changes, Gitbook is the easiest option.
  1. 1.
    ​Click this link to get access to the Gitbook space
  2. 2.
    If you've already clicked the above link and have access, click here to edit or comment.

Commenting on Githubook

  1. 1.
    Just click the speech bubble to the right of any text. More info here​

Editing On Gitbook

  1. 1.
    Follow the instructions here to edit and submit a change request.
Make sure to enter a descriptive subject at the bottom when submitting changes.

Option 2: Edit Locally

This is a good option if you want to get familiar with git or need to contribute code.
Every page is a MarkDown file, which is an easy-to-learn syntax extension to plain text that makes creating links, rendering images, and nice-looking formatting simple.

Fork the Repository

  1. 1.
2. Click on "Fork" to create your own copy of cure-dao/docs to your account
Step 2 screenshot
3. Click on your personal account name
Step 3 screenshot

Install IntelliJ Community Edition

  1. 1.
    Download here​
  2. 2.
    Install it
  3. 3.
    Install Markdown Editor Plugin
  4. 4.
    Click "Get from VCS"
  5. 5.
    Select repository
  6. 6.
    Select the file you want to edit on the left in "Projects" tab
  7. 7.
    Click "Markdown Editor" tab at the bottom for the visual editor

Edit with IntelliJ

  1. 1.
    Go to your GitHub fork and Fetch Upstream
  2. 2.
    Press Shift twice quickly in succession and type "Update Project" to update local copy
  3. 3.
    Make changes/edits
  4. 4.
    Press Shift twice quickly in succession and start typing "Show Local Changes"
  5. 5.
    Double-click on "Show Local Changes"
  6. 6.
    Review changes
  7. 7.
    Type in a commit message and click "Commit and push"
  8. 8.
    Go to your forked GitHub repository and click "Contribute" button
  9. 9.
    Click Create Pull Request

How to Edit and Submit Your Changes

Here are some helpful tutorials:

Other Options

Editing Directly on GitHub

(recommended for beginners or small changes)
The fastest way is to edit directly on GitHub.
Each page has an "Edit on GitHub" link to the right of the content. By clicking it you are taken to the GitHub sign-in page, where you can either log in or create an account.
Once logged in, you'll be taken to the GitHub built-in text editor where you can make your edits directly. When you've completed your changes, you can add any specific details on what was changed create a new Pull Request to the repository. From there one of the maintainers will review your changes, and either merge them or request changes.
Remember that after you click "Propose Changes", you must also click on "Create Pull Request" on the next page.
The process is illustrated in this visual walk-through.
  1. 1.
    Contributors should attempt to adhere to the prevailing MarkDown style, language, and layout.
  2. 2.
    Please adhere to the guidelines in the Writing Style Guide.
  3. 3.
    Commit messages should be as detailed as possible to describe the changes made.

Editing in Online VS Code

You can also instantly open anything in an online version of VSCode in either of the following ways:
  1. 1.
    Click the Fork button to create your own copy of this repository.
  2. 2.
    Press the . character while browsing YOUR FORKED repository or pull request on GitHub.
  3. 3.
    Edit in VS Code
  4. 4.
    Click the Branch icon on the left
  5. 5.
    Click the plus next to modified files
  6. 6.
    Add a commit description
  7. 7.
    Click the checkmark to commit
  8. 8.
    Click the sync button at the bottom to upload your changes
  9. 9.
    Open YOUR FORKED repository on GitHub
  10. 10.
    Click "Contribute" to make a pull request back to the main repo.