Skip to main content

BlogChain

The place where the blog meets the chain

6 minutes read

Kadena’s Community-Powered Developer Documentation

Entering 2022, the Kadena ecosystem is going into overdrive, so it’s critical that our developer documentation keep up. We’re thrilled to announce a major refresh of the Kadena developer documentation hub to supercharge builder’s access to information. What’s more, the docs are now fully community-powered, open- and crowd-sourced, tapping the incredible resources in our community to keep everything up-to-date and accurate. Read on to learn how you can get involved and move our ecosystem forward!

How to Contribute to Kadena Docs

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

Edit from the Docs

Edit from the GitHub Repo

Edit from a Local Environment

Before Getting Started

GitHub

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

github
github

Markdown

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

markdown
markdown

Docusaurus

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

docusaurus
docusaurus

Edit from the Docs

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

docs
docs

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

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

Select the Show diff checkbox to view the changes inline.

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.

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.

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

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

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

Select the Show diff checkbox to view the changes inline.

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.

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.

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

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

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

Example

bash
git clone [https://github.com/kadena-community/docs.git](https://github.com/kadena-community/docs.git)
bash
git clone [https://github.com/kadena-community/docs.git](https://github.com/kadena-community/docs.git)

Change into the docs/ directory

bash
cd docs
bash
cd docs

Run yarn to install the project dependencies.

bash
yarn
bash
yarn

Run yarn dev to run the local server.

bash
yarn dev
bash
yarn dev

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

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.

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

bash
git status
bash
git status

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

bash
git add .
bash
git add .

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’

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

bash
git push origin master
bash
git push origin master

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

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.