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 docs/docs/contributing/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
7 changes: 5 additions & 2 deletions docs/docs/contributing/setup_dev_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
],
},
Expand All @@ -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',
Expand Down