Skip to main content
Last updated

Contribute to Kadena Docs

The Kadena documentation is open source and hosted on GitHub. Using our public-facing Docs repo in the Kadena Community GitHub, you can make suggested changes using pull requests. This allows community members to improve the documentation and helps improve the Kadena developer experience.

There are 3 ways to contribute to the Docs depending on where you are starting from.

  • From the Docs
  • From GitHub
  • From a Local Environment.

This article goes over each of these options to help you suggest changes to the Kadena Docs.

Before Getting Started

GitHub

Create a GitHub account here and read their documentation if you have trouble getting started.

Markdown

Learn about Markdown to better understand the syntax for editing documentation.

github
github

Docusaurus

Read the Docusaurus Docs to get familiar with the tool used to publish the Kadena Documentation.

github
github

Edit from the Docs

At the bottom of any page of the Kadena Documentation, you’ll see a link titled **Edit this page. **

github
github

Selecting this link takes you to the kadena-community/docs editor window for this page within GitHub.

github
github

Make adjustments as needed and preview your changes using the Preview tab.

github
github

Select the **Show diff **checkbox to view the changes inline.

github
github

To propose your changes, scroll to the bottom of the page, add notes about your changes, and select the radio button option to Create a new branch. Name your branch and select propose changes.

github
github

You have now proposed edits to the repo from the documentation. The Kadena team will review your request and merge your changes as soon as possible. View your pull request at any time to see any comments, questions, or suggestions throughout the duration of your pull request.

Edit from the GitHub Repo

Navigate to the Kadena Community GitHub and navigate to the Docs Repo.

github
github

Using the folder structure, navigate to the page you would like to edit (example: docs/basics/overview.md).The location of this file corresponds to the URL found from within the documentation site.

github
github

Select the edit icon on the right side of the screen to begin editing the document.

github
github

Make adjustments as needed and preview your changes using the Preview tab.

github
github

Select the **Show diff **checkbox to view the changes inline.

github
github

To propose your changes, scroll to the bottom of the page, add notes about your changes, and select the radio button option to Create a new branch. Name your branch and select propose changes.

github
github

You have now proposed edits to the repo from GitHub. The Kadena team will review your request and merge your changes as soon as possible. View your pull request at any time to see any comments, questions, or suggestions throughout the duration of your pull request.

Edit from a Local Environment

Navigate to kadena-community/docs and select **Fork **on the top right of your screen.

github
github

Select your profile to create a fork of this repo on your personal GitHub account.

github
github

Navigate to your docs repo fork and copy the URL from the code dropdown.

github
github

Open your terminal, navigate to your preferred folder, and clone the repository.

Example

bash
git clone https://github.com/kadena-community/docs.git
bash
git clone https://github.com/kadena-community/docs.git
github
github

Change into the docs/ directory

bash
cd docs
bash
cd docs
github
github

Run yarn to install the project dependencies.

bash
yarn
bash
yarn
github
github

Run yarn start to run the local server.

bash
yarn start
bash
yarn start
github
github

Navigate to localhost:3000 to view the documentation on local device.

github
github

Open the **docs **folder in your favorite code editor to make changes to the documentation (example: docs > basics > what-is-kda.md). Use markdown to edit the page and save the file to view your changes.

github
github

When you are done editing, check the status of your changes from your terminal window.

bash
git status
bash
git status
github
github

Use **git add **to add stage your changes to commit to your local repository.

bash
git add .
bash
git add .
github
github

Use **git commit **to commit your changes to your local repository.

bash
git commit -m 'how to edit docs'
bash
git commit -m 'how to edit docs'
github
github

Use **git push **to push your changes to your remote repository.

bash
git push origin main
bash
git push origin main
github
github

Select Contribute > Open pull request from within your remote repository.

github
github

You have now created a pull request to the repo from a local environment. The Kadena team will review your request and merge your changes as soon as possible. View your pull request at any time to see any comments, questions, or suggestions throughout the duration of your pull request.