Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typo fix and removed unavailable config option #52

Merged
merged 2 commits into from
Aug 27, 2024

Conversation

harishkotra
Copy link
Collaborator

@harishkotra harishkotra commented Aug 26, 2024

Removed the word test written twice in the command. This is in the Install and Uninstall page.

image

Removed --embedding-batch-size from the config list as it is not a support config option for a node. This is in the Customize Your GaiaNet Node page.

image

Copy link
Contributor

juntao commented Aug 26, 2024

Hello, I am a PR summary agent on flows.network. Here are my reviews of code commits in this PR.


Summary:

This patch primarily focuses on improving documentation and version control. It highlights potential issues such as an unavailable config option (--embedding-batch-size) in the gaianet configuration command, which may have been deprecated or not applicable to the current version of the software being documented.

The most important findings are:

  1. The addition of a .gitignore file that will exclude 'node_modules', '.docusaurus', and '.DS_Store' files from version control, which will help maintain a cleaner repository and minimize unnecessary files in version control.
  2. Correcting typos in the documentation for customizing the GaiaNet node, installation guide, and example base directory path used during initialization and startup/shutdown commands.
  3. The addition of a contributing section to the README.md file that provides clear instructions for contributors on how to fork, clone, branch, commit, push changes, and create pull requests. This will facilitate collaboration and maintain the project's quality.
  4. The documentation now includes sections on running it locally using npm, project structure, and deployment. These additions will help users understand the development environment better and contribute more effectively to the project.
  5. There is a section added for seeking help if needed. This could be beneficial as it provides a clear pathway for users or contributors who may encounter difficulties while working with the project.

Overall, this patch improves documentation quality and user experience by addressing issues, providing clear instructions for collaboration, and enhancing local development capabilities. It also ensures that unnecessary files are excluded from version control to maintain a cleaner repository.

Details

Commit 3f07a5e00219d489721ab0647c14d49a3cba5110

Key changes:

  1. Added a .gitignore file to exclude 'node_modules', '.docusaurus', and '.DS_Store' files from version control.
  2. Fixed a typo in the documentation for customizing the GaiaNet node, where an incorrect command was used during initialization.
  3. Removed an unavailable config option (--embedding-batch-size) from the gaianet configuration command in the documentation. This may have been deprecated or not applicable to the current version of the software being documented.
  4. Corrected a typo in the example base directory path used during initialization and startup/shutdown commands within the installation guide.

Commit 5db00f407da18437d07329026222c2e2ae6760b9

  • The patch added a contributing section to the README.md file, providing instructions for contributors on how to fork and clone the repository, create a new branch for changes, commit changes, push them to their fork, and create a pull request.
  • It also includes instructions for running the documentation locally using npm and provides information about the project structure.
  • The deployment process is automated, with changes merged into the main branch automatically deploying to docs.gaianet.ai.
  • The patch adds sections on running the documentation locally, project structure, and deployment.
  • It also includes a section for seeking help if needed.

@alabulei1
Copy link
Contributor

alabulei1 commented Aug 27, 2024

Hi @harishkotra

Nice catch.

However, we should support config the embedding-batch-size. I will make a request. Thank you.

@alabulei1 alabulei1 merged commit b9a4806 into GaiaNet-AI:main Aug 27, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants