Skip to content

Commit 5e1a2b3

Browse files
authored
docs: fix multiple documentation errors (#10)
- Fix clone URLs pointing to NousResearch/gauss-agent -> math-inc/OpenGauss - Fix issue tracker URLs to point to math-inc/OpenGauss/issues - Fix MIT license URL to point to math-inc/OpenGauss - Fix Python minimum version from 3.10+ to 3.11+ (matches pyproject.toml) - Fix _config_version reference from 5 to 9 (matches gauss_cli/config.py)
1 parent 829ff4f commit 5e1a2b3

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ The registry handles schema collection, dispatch, availability checking, and err
179179

180180
### config.yaml options:
181181
1. Add to `DEFAULT_CONFIG` in `gauss_cli/config.py`
182-
2. Bump `_config_version` (currently 5) to trigger migration for existing users
182+
2. Bump `_config_version` (currently 9) to trigger migration for existing users
183183

184184
### .env variables:
185185
1. Add to `OPTIONAL_ENV_VARS` in `gauss_cli/config.py` with metadata:

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ If your skill is specialized, community-contributed, or niche, it's better suite
6363
### Clone and install
6464

6565
```bash
66-
git clone --recurse-submodules https://github.com/NousResearch/gauss-agent.git
67-
cd gauss-agent
66+
git clone --recurse-submodules https://github.com/math-inc/OpenGauss.git
67+
cd OpenGauss
6868

6969
# Create venv with Python 3.11
7070
uv venv venv --python 3.11
@@ -638,7 +638,7 @@ test(tools): add unit tests for file_operations
638638
639639
## Reporting Issues
640640
641-
- Use [GitHub Issues](https://github.com/NousResearch/gauss-agent/issues)
641+
- Use [GitHub Issues](https://github.com/math-inc/OpenGauss/issues)
642642
- Include: OS, Python version, Gauss version (`gauss version`), full error traceback
643643
- Include steps to reproduce
644644
- Check existing issues before creating duplicates

website/docs/developer-guide/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ We value contributions in this order:
3333
| Requirement | Notes |
3434
|-------------|-------|
3535
| **Git** | With `--recurse-submodules` support |
36-
| **Python 3.10+** | uv will install it if missing |
36+
| **Python 3.11+** | uv will install it if missing |
3737
| **uv** | Fast Python package manager ([install](https://docs.astral.sh/uv/)) |
3838
| **Node.js 18+** | Optional — needed for browser tools and WhatsApp bridge |
3939

4040
### Clone and Install
4141

4242
```bash
43-
git clone --recurse-submodules https://github.com/NousResearch/gauss-agent.git
44-
cd gauss-agent
43+
git clone --recurse-submodules https://github.com/math-inc/OpenGauss.git
44+
cd OpenGauss
4545

4646
# Create venv with Python 3.11
4747
uv venv venv --python 3.11
@@ -216,7 +216,7 @@ fix(security): prevent shell injection in sudo password piping
216216

217217
## Reporting Issues
218218

219-
- Use [GitHub Issues](https://github.com/NousResearch/gauss-agent/issues)
219+
- Use [GitHub Issues](https://github.com/math-inc/OpenGauss/issues)
220220
- Include: OS, Python version, Gauss version (`gauss version`), full error traceback
221221
- Include steps to reproduce
222222
- Check existing issues before creating duplicates
@@ -230,4 +230,4 @@ fix(security): prevent shell injection in sudo password piping
230230

231231
## License
232232

233-
By contributing, you agree that your contributions will be licensed under the [MIT License](https://github.com/NousResearch/gauss-agent/blob/main/LICENSE).
233+
By contributing, you agree that your contributions will be licensed under the [MIT License](https://github.com/math-inc/OpenGauss/blob/main/LICENSE).

0 commit comments

Comments
 (0)