Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 2.88 KB

setting_up_environment.adoc

File metadata and controls

89 lines (66 loc) · 2.88 KB
Raw

Setting up your environment

Create a GitHub account

Before you can contribute to Starknet documentation, you must sign up for a GitHub account.

Set up authentication

When you have your account set up, follow the instructions to generate and set up SSH keys on GitHub for proper authentication between your workstation and GitHub.

Confirm authentication is working correctly with the following command:

Fork and clone the Starknet documentation repository

For significant contributions, set up the Starknet documentation repository on your workstation so that you can create PRs and contribute. You only have to perform these steps during the initial setup.

Procedure

  1. Fork the https://github.com/starknet-io/starknet-docs repository to your GitHub account from the GitHub UI. You can do this by clicking on Fork in the upper right-hand corner.

  2. In the terminal on your workstation, change into the directory where you want to clone the forked repository.

  3. Clone the forked repository onto your workstation with the following command, replacing <user_name> with your actual GitHub username.

    $ git clone [email protected]:<user_name>/starknet-docs.git

  4. Change into the directory for the local repository you just cloned.

    $ cd starknet-docs

  5. Add an upstream pointer back to Starknet’s remote repository, in this case starknet-docs.

    $ git remote add upstream [email protected]:starknet-io/starknet-docs.git

This ensures that you are tracking the remote repository so you can keep your local repository synchronized.

Previewing the website on your local machine

You don’t need to install Antora to preview the website. This repo includes an embedded Antora installation, which is referred to in the Antora documentation as a local installation.

Prerequisites

You must have an active Node.js LTS release on your machine. See the Antora documentation for your OS:

Tip

Install the optional http server Antora provides so you can view the output in a local web server

Git-related info

  • When creating a new PR, tag one or more of the following as reviewers: stoobie, ArielElp, LucasLvy.

  • When creating a new PR, you need to merge to the main branch.