First upload
This commit is contained in:
22
README.md
22
README.md
@@ -157,7 +157,7 @@ Create a `.env` file in the repo root (same directory as this README). All confi
|
||||
|
||||
> **Important:** After changing `.env`, you must **restart the process** (`npm start` / `node broccolini-discord.js`) for new values to take effect. If you add or change **slash commands** (e.g. `/escalate`, `/email-routing`, `/panel` options), restart the bot so it can **re-register** commands with Discord; otherwise new or updated commands may not appear.
|
||||
|
||||
> **Agent rule:** Changes to `.env` by an AI/agent must **require explicit user confirmation**. Prefer proposing changes to `.env.test` first and migrating to `.env` only after the user approves. See [ENV_AND_SECURITY.md](docs/ENV_AND_SECURITY.md).
|
||||
> **Agent rule:** Changes to `.env` by an AI/agent must **require explicit user confirmation**. Prefer proposing changes to `.env.test` first and migrating to `.env` only after the user approves. See [ENV_AND_SECURITY.md](docs/setup/ENV_AND_SECURITY.md).
|
||||
|
||||
### Discord
|
||||
|
||||
@@ -314,7 +314,7 @@ To try config changes without affecting production, use a **test env**. Copy `.e
|
||||
npm run start:test
|
||||
```
|
||||
|
||||
Other test scripts: `npm run test-mongodb:test`. After confirming behavior in test, migrate only the desired variables to `.env`. See **[ENV_AND_SECURITY.md](docs/ENV_AND_SECURITY.md)** for the full workflow, security checklist, and agent rules.
|
||||
Other test scripts: `npm run test-mongodb:test`. After confirming behavior in test, migrate only the desired variables to `.env`. See **[ENV_AND_SECURITY.md](docs/setup/ENV_AND_SECURITY.md)** for the full workflow, security checklist, and agent rules.
|
||||
|
||||
To test the MongoDB connection from the repo root: `npm run test-mongodb`.
|
||||
|
||||
@@ -505,18 +505,18 @@ Use this endpoint for uptime monitoring or container health probes. Optional: se
|
||||
|
||||
## Documentation
|
||||
|
||||
Additional guides and reference docs live in **`docs/`**:
|
||||
Additional guides and reference docs live in **`docs/`**. See [docs/README.md](docs/README.md) for the full index.
|
||||
|
||||
| Doc | Description |
|
||||
|-----|-------------|
|
||||
| [QUICKSTART](docs/QUICKSTART.md) | Get started in a few minutes: first response, panel, tags, priority |
|
||||
| [ENV_AND_SECURITY](docs/ENV_AND_SECURITY.md) | Test env workflow, security checklist, agent rules |
|
||||
| [MONGODB_SETUP](docs/MONGODB_SETUP.md) | MongoDB connection, schemas, and testing |
|
||||
| [PROJECT_STRUCTURE](docs/PROJECT_STRUCTURE.md) | File and directory layout |
|
||||
| [PROPOSAL](docs/PROPOSAL.md) | Roadmap and possible next steps |
|
||||
| [PHASE_FEATURES](docs/PHASE_FEATURES.md) | Phased feature list and variables |
|
||||
| [FEATURES_SUMMARY](docs/FEATURES_SUMMARY.md) · [NEW_FEATURES](docs/NEW_FEATURES.md) | Feature overview and changelog |
|
||||
| [DISCORD_API_IMPROVEMENTS](docs/DISCORD_API_IMPROVEMENTS.md) · [DISCORD_API_VALIDATION](docs/DISCORD_API_VALIDATION.md) | Discord API implementation notes |
|
||||
| [QUICKSTART](docs/setup/QUICKSTART.md) | Get started in a few minutes: first response, panel, tags, priority |
|
||||
| [ENV_AND_SECURITY](docs/setup/ENV_AND_SECURITY.md) | Test env workflow, security checklist, agent rules |
|
||||
| [MONGODB_SETUP](docs/setup/MONGODB_SETUP.md) | MongoDB connection, schemas, and testing |
|
||||
| [PROJECT_STRUCTURE](docs/setup/PROJECT_STRUCTURE.md) | File and directory layout |
|
||||
| [PROPOSAL](docs/features/PROPOSAL.md) | Roadmap and possible next steps |
|
||||
| [PHASE_FEATURES](docs/features/PHASE_FEATURES.md) | Phased feature list and variables |
|
||||
| [FEATURES_SUMMARY](docs/features/FEATURES_SUMMARY.md) · [NEW_FEATURES](docs/features/NEW_FEATURES.md) | Feature overview and changelog |
|
||||
| [DISCORD_API_IMPROVEMENTS](docs/api/DISCORD_API_IMPROVEMENTS.md) · [DISCORD_API_VALIDATION](docs/api/DISCORD_API_VALIDATION.md) | Discord API implementation notes |
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user