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.
For quick, small changes, Gitbook is the easiest option.
This is a good option if you want to get familiar with git or need to contribute code.
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
- 2.Install it
- 3.Install Markdown Editor Plugin
- 4.Click "Get from VCS"
- 5.Select repository
- 6.Select the file you want to edit on the left in "Projects" tab
- 7.Click "Markdown Editor" tab at the bottom for the visual editor
- 1.Go to your GitHub fork and Fetch Upstream
- 2.Press Shift twice quickly in succession and type "Update Project" to update local copy
- 3.Make changes/edits
- 4.Press Shift twice quickly in succession and start typing "Show Local Changes"
- 5.Double-click on "Show Local Changes"
- 6.Review changes
- 7.Type in a commit message and click "Commit and push"
- 8.Go to your forked GitHub repository and click "Contribute" button
- 9.Click Create Pull Request
Here are some helpful tutorials:
(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.
- 1.Contributors should attempt to adhere to the prevailing
MarkDownstyle, language, and layout.
- 3.Commit messages should be as detailed as possible to describe the changes made.
You can also instantly open anything in an online version of VSCode in either of the following ways:
- 1.Click the
Forkbutton to create your own copy of this repository.
- 2.Press the
.character while browsing YOUR FORKED repository or pull request on GitHub.
- 3.Edit in VS Code
- 4.Click the Branch icon on the left
- 5.Click the plus next to modified files
- 6.Add a commit description
- 7.Click the checkmark to commit
- 8.Click the sync button at the bottom to upload your changes
- 9.Open YOUR FORKED repository on GitHub
- 10.Click "Contribute" to make a pull request back to the main repo.