We use Mintlify to power our documentation. You can contribute to our documentation by following the steps below.

​
Prerequisites

  • Git installed on your machine (If you don’t have git on your machine, install it from here)
  • SSH key added to your GitHub account (If you don’t have an SSH key, generate one from here)
  • Access to the oxy repository

​
Get started

1

Set up repository

Ignore this step if you have already cloned the repository.

From the directory of your choice (e.g. ~/repos or ~/projects), git clone the oxy repository by running the following command on your terminal.

terminal
git clone git@github.com:oxy-hq/oxy.git
2

Set up development environment

Install Mintlify CLI by running the following command on your terminal.

This step is required to preview the changes you make to the documentation locally.

terminal
npm install -g @mintlify/cli

​
Update documentation

1

Create a branch

Change to the repository directory on your computer (if you are not already there):

terminal
cd oxy

Then create and switch to a new branch using the following command:

terminal
git checkout -b <name>/<description>
# Example: git checkout -b jinjae/add-redshift-integration
2

Make necessary changes

Now open the page you’d like to edit and make the necessary changes.

3

Preview changes locally

Save the changes you’ve made by pressing Cmd + S (Mac) or Ctrl + S (Windows).

Change to the docs directory on your computer by running the following command:

terminal
cd docs/

Then run the following command to preview changes locally:

terminal
mintlify dev

This command must be run from the docs directory where the mint.json file exists. If not, you will get an error “Must be run in a directory where a mint.json file exists.”

4

Add and commit changes

Once you are happy with the changes you’ve made, add and commit those changes.

terminal
git add .
git commit -m "docs: improve bigquery page"

​
Submit changes

1

Push changes to GitHub

Once you’re ready to publish changes, push your changes!

If your local branch hasn’t been published to remote yet, publish your branch first.
To publish (push) a local branch to the remote repository for the first time, use:

terminal
git push -u origin "new-branch-name"
# Example: git push -u origin jinjae/docs-improve-bigquery

After this initial push, you can simply use:

terminal
git push
2

Submit your changes for review

Finally, if you are happy with the changes you’ve made, create a pull request.

You can create a PR by going to your branch on GitHub, and clicking on the Contribute button.

Clicking on the Contribute button will open a dropdown menu with an option to create a pull request.

Finally, add @jinjakim as the reviewer, and create the pull request.

Refer to the PR Guidelines below for more information on how to create a PR.

​
PR Guidelines

  • Title format: <type>: <description> (e.g. docs: improvements to bigquery integration page)
  • Add description of changes.
  • Request review from @jinjakim by adding @jinjakim to as the reviewer.
  • Changes will be published when PR is reviewed and merged.

​
Help

For more information on formatting the documentation, refer to Mintlify’s documentation.