Commands Used for Dev Docs

gistfile1.md

Get the code and run on localhost

git clone git@github.com:stellar/stellar-docs.git 
cd stellar-docs
yarn install 
npx docusaurus start

This puts you on a new local branch

Make sure you start on the main branch, and git pull latest. Now:

git branch my-branch-name
git checkout my-branch-name

Make your changes

• As discussed, work primarily in /docs folder. The structure under /docs resembles to the docs horizontal top navbar

Commit your changes

git add .
git commit -m "Your commit message"
git push --set-upstream origin my-branch-name // This command creates a remote branch with the same name on Github.com

Are there formatting issues?

npm run format:mdx 

Making more changes

git add .
git commit -m "New commit message"
git push (the second time you push, you don't need to create a branch, the remote branch on github already exists)

On Github

Click on the diff button to create your PR first. Wait for PR to build and a preview the link to generate, on which you can view your changes. Once you get an approval, you can merge the PR.