diff --git a/docs/docs/contributing/guide.md b/docs/docs/contributing/guide.md index d176b989..23ffefff 100644 --- a/docs/docs/contributing/guide.md +++ b/docs/docs/contributing/guide.md @@ -24,7 +24,7 @@ To submit your code: 1. Fork the [CocoIndex repository](https://github.com/cocoindex-io/cocoindex) 2. [Create a new branch](https://docs.github.com/en/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop) on your fork 3. Make your changes -4. Run the pre-commit checks (automatically triggered on `git commit`) +4. Run the pre-commit checks. It will be automatically triggered on `git commit` after you install the pre-commit hooks by `pre-commit install` (see [Setup Development Environment](setup_dev_environment.md)). :::tip To run them manually (same as CI): diff --git a/docs/docs/contributing/setup_dev_environment.md b/docs/docs/contributing/setup_dev_environment.md index 40a97708..7fa537dd 100644 --- a/docs/docs/contributing/setup_dev_environment.md +++ b/docs/docs/contributing/setup_dev_environment.md @@ -20,13 +20,14 @@ Follow the steps below to get CocoIndex built on the latest codebase locally - i ```sh python3 -m venv .venv ``` - Activate the virtual environment, before any installing / building / running: + + Activate the virtual environment, before any installing / building / running below: ```sh . .venv/bin/activate ``` -- Install required tools: +- Install required tools under the virtual environment: ```sh pip install maturin ``` @@ -36,6 +37,8 @@ Follow the steps below to get CocoIndex built on the latest codebase locally - i maturin develop -E all,dev ``` + This step needs to be repeated whenever you make changes to the Rust code. + - Install and enable pre-commit hooks. This ensures all checks run automatically before each commit: ```sh pre-commit install diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 90fa5db6..17a85ad1 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -71,8 +71,8 @@ const sidebars: SidebarsConfig = { label: 'Contributing', collapsed: false, items: [ - 'contributing/guide', 'contributing/setup_dev_environment', + 'contributing/guide', 'contributing/new_built_in_target', ], }, @@ -90,7 +90,7 @@ const sidebars: SidebarsConfig = { type: 'category', label: 'Examples', collapsed: false, - link: {type: 'doc', id: 'examples/index'}, + link: { type: 'doc', id: 'examples/index' }, items: [ { type: 'autogenerated',