[bug:6117:docs]: fix inconsistent configuration and troubleshooting guidance (#6118)

This commit is contained in:
Trisha
2026-03-11 02:41:54 -04:00
committed by GitHub
parent e5e57302fa
commit a79d7de482
3 changed files with 19 additions and 36 deletions
+16 -33
View File
@@ -74,42 +74,25 @@ Install `make` using:
```bash
sudo apt install make
```
uv: command not found
Install uv using:
curl -LsSf https://astral.sh/uv/install.sh | sh
source ~/.bashrc
ruff: not found
If linting fails due to a missing ruff command, install it with:
uv tool install ruff
WSL Path Recommendation
When using WSL, it is recommended to clone the repository inside your Linux home directory (e.g., ~/hive) instead of under /mnt/c/... to avoid potential performance and permission issues.
---
# ✅ Why This Is Good
- Clear
- Professional tone
- No unnecessary explanation
- Under micro-fix size
- Based on real contributor experience
- Wont annoy maintainers
---
Now:
### `uv: command not found`
Install `uv` using:
```bash
git checkout -b docs/setup-troubleshooting
curl -LsSf https://astral.sh/uv/install.sh | sh
source ~/.bashrc
```
### `ruff: not found`
If linting fails due to a missing `ruff` command, install it with:
```bash
uv tool install ruff
```
### WSL Path Recommendation
When using WSL, it is recommended to clone the repository inside your Linux home directory (e.g., ~/hive) instead of under /mnt/c/... to avoid potential performance and permission issues.
## Commit Convention
+2 -2
View File
@@ -39,8 +39,8 @@ We consider security research conducted in accordance with this policy to be:
## Security Best Practices for Users
1. **Keep Updated**: Always run the latest version
2. **Secure Configuration**: Review `config.yaml` settings, especially in production
3. **Environment Variables**: Never commit `.env` files or `config.yaml` with secrets
2. **Secure Configuration**: Review your `~/.hive/configuration.json`, `.mcp.json`, and environment variable settings, especially in production
3. **Environment Variables**: Never commit `.env` files or any configuration files that contain secrets
4. **Network Security**: Use HTTPS in production, configure firewalls appropriately
5. **Database Security**: Use strong passwords, limit network access
+1 -1
View File
@@ -172,7 +172,7 @@ Add to `.vscode/settings.json`:
## Security Best Practices
1. **Never commit API keys** - Use environment variables or `.env` files
2. **`.env` is git-ignored** - Copy `.env.example` to `.env` at the project root and fill in your values
2. **If you use a local `.env` file, keep it private** - This repository does not include a root `.env.example`; use your own local `.env` file or shell environment variables for secrets
3. **Use real provider keys in non-production environments** - validate configuration with low-risk inputs before production rollout
4. **Credential isolation** - Each tool validates its own credentials at runtime