-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #52 from harishkotra/main
typo fix and removed unavailable config option
- Loading branch information
Showing
4 changed files
with
58 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
node_modules | ||
.docusaurus | ||
.DS_Store | ||
.vscode/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,59 @@ | ||
# GaiaNet Docs | ||
|
||
# GaiaNet Docs | ||
|
||
The documentation is for GaiaNet node operators, users, and creators. | ||
|
||
Feel free to create a PR if there is anything that needs to be improved. | ||
## Contributing | ||
|
||
We welcome contributions to improve our documentation! Here's how you can contribute: | ||
1. Fork the repository: | ||
- Visit the [GaiaNet docs repository](https://github.com/GaiaNet-AI/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" | ||
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: | ||
1. Install dependencies: | ||
``` | ||
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.gaianet.ai](https://docs.gaianet.ai) 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 GaiaNet's documentation! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters