Skip to content

Commit 0b80e44

Browse files
authored
organize docs for contributing guide (#883)
* Update icon.svg * organize contributing section * Update custom.css * fix link * Update docusaurus.config.ts
1 parent e8bd0e2 commit 0b80e44

File tree

7 files changed

+80
-60
lines changed

7 files changed

+80
-60
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
We love contributions from our community ❤️. Please check out our [contributing guide](https://cocoindex.io/docs/about/contributing).
1+
We love contributions from our community ❤️. Please check out our [contributing guide](https://cocoindex.io/docs/contributing/guide).

docs/docs/about/community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We are super excited for community contributions of all kinds - whether it's cod
1212
We would love to foster an inclusive, welcoming, and supportive environment. Contributing to CocoIndex should feel collaborative, friendly and enjoyable for everyone. Together, we can build better AI applications through robust data infrastructure.
1313

1414
:::tip Start hacking CocoIndex
15-
Check out our [Contributing guide](./contributing) to get started!
15+
Check out our [Contributing guide](/docs/contributing/guide) to get started!
1616
:::
1717

1818

Lines changed: 6 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,20 @@
11
---
2-
title: Contributing
3-
description: Learn how to contribute to CocoIndex
2+
title: Contributing Guide
3+
description: How to contribute to CocoIndex
44
---
55

6-
# Contributing
7-
86
[CocoIndex](https://github.com/cocoindex-io/cocoindex) is an open source project. We are respectful, open and friendly. This guide explains how to get involved and contribute to [CocoIndex](https://github.com/cocoindex-io/cocoindex).
97

10-
## Issues:
11-
12-
We use [GitHub Issues](https://github.com/cocoindex-io/cocoindex/issues) to track bugs and feature requests.
8+
Our [Discord server](https://discord.com/invite/zpA9S2DR7s) is constantly open.
9+
If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly.
1310

1411
## Good First Issues
1512

1613
We tag issues with the ["good first issue"](https://github.com/cocoindex-io/cocoindex/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label for beginner contributors.
1714

1815
## How to Contribute
19-
- If you decide to work on an issue, unless the PR can be sent immediately (e.g. just a few lines of code), we recommend you to leave a comment on the issue like **`I'm working on it`** or **`Can I work on this issue?`** to avoid duplicating work.
16+
- If you decide to take an issue, we recommend you to leave a comment on the issue like **`Can I work on this issue?`** so we could assign it to you. This helps you and others avoid duplicating work.
2017
- For larger features, we recommend you to discuss with us first in our [Discord server](https://discord.com/invite/zpA9S2DR7s) to coordinate the design and work.
21-
- Our [Discord server](https://discord.com/invite/zpA9S2DR7s) is constantly open. If you are unsure about anything, it is a good place to discuss! We'd love to collaborate and will always be friendly.
22-
23-
## Start hacking! Setting Up Development Environment
24-
Follow the steps below to get cocoindex built on the latest codebase locally - if you are making changes to cocoindex functionality and want to test it out.
25-
26-
- 🦀 [Install Rust](https://rust-lang.org/tools/install)
27-
28-
If you don't have Rust installed, run
29-
```sh
30-
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
31-
```
32-
Already have Rust? Make sure it's up to date
33-
```sh
34-
rustup update
35-
```
36-
37-
- Setup Python virtual environment:
38-
```sh
39-
python3 -m venv .venv
40-
```
41-
Activate the virtual environment, before any installing / building / running:
42-
43-
```sh
44-
. .venv/bin/activate
45-
```
46-
47-
- Install required tools:
48-
```sh
49-
pip install maturin
50-
```
51-
52-
- Build the library. Run at the root of cocoindex directory:
53-
```sh
54-
maturin develop -E all,dev
55-
```
56-
57-
- Install and enable pre-commit hooks. This ensures all checks run automatically before each commit:
58-
```sh
59-
pre-commit install
60-
```
61-
62-
- Before running a specific example, set extra environment variables, for exposing extra traces, allowing dev UI, etc.
63-
```sh
64-
. ./.env.lib_debug
65-
```
6618

6719
## Submit Your Code
6820
CocoIndex is committed to the highest standards of code quality. Please ensure your code is thoroughly tested before submitting a PR.
@@ -89,6 +41,7 @@ In your PR description, please include:
8941
- Note if it's a breaking change
9042
- Reference any related GitHub issues
9143

44+
9245
A core team member will review your PR within one business day and provide feedback on any required changes. Once approved and all tests pass, the reviewer will squash and merge your PR into the main branch.
9346

9447
Your contribution will then be part of CocoIndex! We'll highlight your contribution in our release notes 🌴.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Setup Development Environment
3+
description: Learn how to setup your development environment to develop CocoIndex
4+
---
5+
6+
Follow the steps below to get CocoIndex built on the latest codebase locally - if you are making changes to CocoIndex functionality and want to test it out.
7+
8+
- 🦀 [Install Rust](https://rust-lang.org/tools/install)
9+
10+
If you don't have Rust installed, run
11+
```sh
12+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
13+
```
14+
Already have Rust? Make sure it's up to date
15+
```sh
16+
rustup update
17+
```
18+
19+
- Setup Python virtual environment:
20+
```sh
21+
python3 -m venv .venv
22+
```
23+
Activate the virtual environment, before any installing / building / running:
24+
25+
```sh
26+
. .venv/bin/activate
27+
```
28+
29+
- Install required tools:
30+
```sh
31+
pip install maturin
32+
```
33+
34+
- Build the library. Run at the root of cocoindex directory:
35+
```sh
36+
maturin develop -E all,dev
37+
```
38+
39+
- Install and enable pre-commit hooks. This ensures all checks run automatically before each commit:
40+
```sh
41+
pre-commit install
42+
```
43+
44+
- Before running a specific example, set extra environment variables, for exposing extra traces, allowing dev UI, etc.
45+
```sh
46+
. ./.env.lib_debug
47+
```

docs/docusaurus.config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ const config: Config = {
6565
from: '/ops/storages',
6666
to: '/ops/targets',
6767
},
68+
{
69+
from: '/about/contributing',
70+
to: '/contributing/guide',
71+
},
6872
],
6973
},
7074
],

docs/sidebars.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,21 @@ const sidebars: SidebarsConfig = {
6666
id: 'query',
6767
label: 'Query Support',
6868
},
69+
{
70+
type: 'category',
71+
label: 'Contributing',
72+
collapsed: false,
73+
items: [
74+
'contributing/guide',
75+
'contributing/setup_dev_environment',
76+
],
77+
},
6978
{
7079
type: 'category',
7180
label: 'About',
7281
collapsed: false,
7382
items: [
7483
'about/community',
75-
'about/contributing',
7684
],
7785
},
7886
],

docs/src/css/custom.css

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,17 @@
9797
}
9898
}
9999

100+
.navbar__logo{
101+
height: 24px;
102+
line-height: 24px;
103+
margin-right: 4px;
104+
}
105+
100106
.navbar__title {
101-
font-family: 'Questrial', sans-serif;
102-
font-size: 1.125rem;
103-
/* 18px */
107+
font-size: 1.125rem; /* 18px */
104108
color: var(--my-color-text-black);
109+
font-weight: bold;
110+
font-family: 'Helvetica Neue', Arial, sans-serif;
105111
}
106112

107113
.navbar {
@@ -110,7 +116,9 @@
110116
/* 14px */
111117
border-bottom: 1px solid var(--ifm-color-emphasis-200);
112118
}
113-
119+
.navbar__item{
120+
margin-top: 3px;
121+
}
114122
.sidebarItemTitle_pO2u,
115123
.navbar__items {
116124
font-family: 'Questrial', sans-serif;

0 commit comments

Comments
 (0)