Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docker-image.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

build:

runs-on: kali-linux:kali-rolling
runs-on: Ubuntu-latest

steps:
- uses: actions/checkout@v4
Expand Down
117 changes: 70 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,84 @@
[![Website](https://img.shields.io/badge/website-000000?style=for-the-badge&logo=About.me&logoColor=white)](https://optimai.network/?utm_source=github_docs) [![X (Twitter)](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/optimainetwork) [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/OptimAINetwork)
# 🌟 OptimAI Network Documentation

[![Website](https://img.shields.io/badge/website-000000?style=for-the-badge&logo=About.me&logoColor=white)](https://optimai.network/?utm_source=github_docs) [![X (Twitter)](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://x.com/optimainetwork) [![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/OptimAINetwork)

This repository contains the source code for [docs.optimai.network](https://docs.optimai.network/).

🔗 Visit our main website at [optimai.network](https://optimai.network) to learn more about our Decentralized Data Network! ✨

## Contributing
## Contributing

We welcome contributions to improve our documentation! Here's how you can contribute:
1. Fork the repository:
- Visit the [OptimAI Network Docs repository](https://github.com/optimainetwork/docs) on GitHub
- Click the "Fork" button in the top-right corner
- Select where you want to fork the repository (your personal account or an organization)
2. Clone your forked repository:`
We welcome contributions to improve our documentation! Here's how you can contribute:

1. Fork the repository:
- Visit the [OptimAI Network Docs repository](https://github.com/optimainetwork/docs) on GitHub
- Click the "Fork" button in the top-right corner
- Select where you want to fork the repository (your personal account or an organization)
2. Clone your forked repository:

```
git clone https://github.com/YOUR-USERNAME/docs.git
cd docs
3. Create a new branch for your changes:`
```
git checkout -b your-feature-branch
```

4. Make your changes to the documentation
5. Commit your changes:`
```
git add .
git commit -m "Description of your changes"
```

3. Create a new branch for your changes:

```
git checkout -b your-feature-branch
```

4. Make your changes to the documentation
5. Commit your changes:

```
git add .
git commit -m "Description of your changes"
```

6. Push your changes to your fork:
```
git push origin your-feature-branch
7. Create a pull request:
- Go to your fork on GitHub
- Click "Pull request" and select "New pull request"
- Select your feature branch and submit the pull request
Please ensure your contributions align with our documentation style and standards.

## Running the Documentation Locally
After forking and cloning the repository:

```
git push origin your-feature-branch
```

7. Create a pull request:
- Go to your fork on GitHub
- Click "Pull request" and select "New pull request"
- Select your feature branch and submit the pull request

Please ensure your contributions align with our documentation style and standards.

## Running the Documentation Locally

After forking and cloning the repository:

1. Install dependencies:
```
npm install

```
npm install
```

2. Start the development server:
```
npm start
3. Open your browser and visit `http://localhost:3000`

## Structure
- `docs/`: Contains all the markdown files for the documentation
- `src/`: Custom React components and pages
- `static/`: Static assets like images
- `docusaurus.config.js`: Main configuration file for Docusaurus

## Deployment
This documentation is automatically deployed to [docs.optimai.network](https://docs.optimai.network) when changes are merged into the main branch.

## Need Help?
If you have any questions or need assistance, please open an issue in this repository or reach out through our community channels.

Thank you for contributing to OptimAI Network's documentation!

```
npm start
```

3. Open your browser and visit `http://localhost:3000`

## Structure

- `docs/`: Contains all the markdown files for the documentation
- `src/`: Custom React components and pages
- `static/`: Static assets like images
- `docusaurus.config.js`: Main configuration file for Docusaurus

## Deployment

This documentation is automatically deployed to [docs.optimai.network](https://docs.optimai.network) when changes are merged into the main branch.

## Need Help?

If you have any questions or need assistance, please open an issue in this repository or reach out through our community channels.

Thank you for contributing to OptimAI Network's documentation!
Loading