Southern Cross AI Docs

This is a overview on how to update the documentation for the Southern Cross AI.

Quick Start

Fork and Clone the Repository: Clone the project to your local machine to get started.
```
git clone https://github.com/Southern-Cross-AI/docs.git
```
Install Dependencies: Navigate to the project directory and install its dependencies.
```
npm install
```
Alternatively, use yarn or pnpm if you prefer.
Start the Development Server: Run the development server to see your changes in real time.
```
npm run dev
```
You can also use yarn dev, pnpm dev, or bun dev based on your setup.

Create a New Branch: Create a new branch for your changes.
```
git checkout -b your-branch-name
```
Make Your Changes: Implement the changes or improvements you're contributing.
Commit Your Changes: Commit your changes with a descriptive message.
```
git add .
git commit -m "Your descriptive commit message"
```

Push to Your Fork: If it's your first contribution, make sure to fork the repository. Then, push your branch to your fork.
```
git push origin your-branch-name
```
Open a Pull Request (PR): Navigate to the original repository on GitHub. You should see a prompt to open a pull request with your changes. If not, go to the "Pull requests" tab, click "New pull request", then "compare across forks", and select your branch.
Describe Your PR: Provide a concise title and detailed description for your pull request. Explain the changes you've made and their impact.
Submit the PR: Submit your pull request. Await feedback or approval from the project maintainers.

First, run npm install to install the dependencies.

Then, run npm run dev to start the development server and visit localhost:3000.