From 3f07a5e00219d489721ab0647c14d49a3cba5110 Mon Sep 17 00:00:00 2001 From: Harish Kotra Date: Mon, 26 Aug 2024 18:55:28 +0530 Subject: [PATCH 1/2] typo fix and removed unavailable config option --- .gitignore | 4 ++++ docs/node-guide/customize.md | 1 - docs/node-guide/install_uninstall.md | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7cf6e79 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +node_modules +.docusaurus +.DS_Store +.vscode/* \ No newline at end of file diff --git a/docs/node-guide/customize.md b/docs/node-guide/customize.md index ae7cb6e..27e3226 100644 --- a/docs/node-guide/customize.md +++ b/docs/node-guide/customize.md @@ -79,7 +79,6 @@ gaianet config \ --snapshot https://huggingface.co/datasets/gaianet/london/resolve/main/london_768_nomic-embed-text-v1.5-f16.snapshot.tar.gz \ --embedding-url https://huggingface.co/gaianet/Nomic-embed-text-v1.5-Embedding-GGUF/resolve/main/nomic-embed-text-v1.5.f16.gguf \ --embedding-ctx-size 8192 \ - --embedding-batch-size 8192 \ --system-prompt "You are a tour guide in London, UK. Please answer the question from a London visitor accurately." \ --rag-prompt "The following text is the context for the user question.\n----------------\n" ``` diff --git a/docs/node-guide/install_uninstall.md b/docs/node-guide/install_uninstall.md index 6e08118..ad07568 100644 --- a/docs/node-guide/install_uninstall.md +++ b/docs/node-guide/install_uninstall.md @@ -26,7 +26,7 @@ The GaiaNet node will be installed in your `$HOME/gaianet` folder by default. > # Assume that you're in the root directory > mkdir test > curl -sSfL 'https://github.com/GaiaNet-AI/gaianet-node/releases/latest/download/install.sh' | bash -s -- --base $HOME/test -> gaianet init --base $HOME/testtest +> gaianet init --base $HOME/test > gaianet start --base $HOME/test > gaianet stop --base $HOME/test > ``` From 5db00f407da18437d07329026222c2e2ae6760b9 Mon Sep 17 00:00:00 2001 From: Harish Kotra Date: Mon, 26 Aug 2024 19:21:17 +0530 Subject: [PATCH 2/2] added readme context for contributors --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 53 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e9316c3..da74402 100644 --- a/README.md +++ b/README.md @@ -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! \ No newline at end of file