Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Comprehensive rewrite and expansion of the OmniBot documentation to better onboard new contributors, including setup instructions, internal architecture explanations, contribution guidelines, and legal pages, with navigation updates in the VitePress sidebar for both EN and FR locales.
Changes:
- Rewrote core developer guides (getting started, modules, commands, listeners, interactions, services, configuration, database) in English and French.
- Added new architecture and contributing pages (EN + FR), plus privacy policy and terms of service (EN + FR).
- Updated VitePress sidebar to include the new pages.
Reviewed changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/site/fr/legal/terms.md | Adds FR terms of service page. |
| docs/site/fr/legal/privacy.md | Adds FR privacy policy page. |
| docs/site/fr/guide/services.md | Expands FR services guide with examples and best practices. |
| docs/site/fr/guide/listeners.md | Expands FR listeners guide incl. auto-activation details and intents. |
| docs/site/fr/guide/interactions.md | Expands FR interactions guide incl. customId args, admin gating, best practices. |
| docs/site/fr/guide/getting-started.md | Rewrites FR getting started with prerequisites, setup/run steps, project structure. |
| docs/site/fr/guide/database.md | Rewrites FR Prisma/database guide incl. consolidation system and models. |
| docs/site/fr/guide/creating-a-module.md | Rewrites FR module creation guide with step-by-step example and APIs. |
| docs/site/fr/guide/contributing.md | Adds FR contribution guide (workflow, tooling, tests). |
| docs/site/fr/guide/configuration.md | Rewrites FR configuration guide with field types, persistence, admin UI flow. |
| docs/site/fr/guide/commands.md | Rewrites FR commands guide with options/autocomplete/propagation details. |
| docs/site/fr/guide/architecture.md | Adds FR architecture overview (boot, loaders, registry, dispatch). |
| docs/site/en/legal/terms.md | Adds EN terms of service page. |
| docs/site/en/legal/privacy.md | Adds EN privacy policy page. |
| docs/site/en/guide/services.md | Expands EN services guide with examples and best practices. |
| docs/site/en/guide/listeners.md | Expands EN listeners guide incl. auto-activation details and intents. |
| docs/site/en/guide/interactions.md | Expands EN interactions guide incl. customId args, admin gating, best practices. |
| docs/site/en/guide/getting-started.md | Rewrites EN getting started with prerequisites, setup/run steps, project structure. |
| docs/site/en/guide/database.md | Rewrites EN Prisma/database guide incl. consolidation system and models. |
| docs/site/en/guide/creating-a-module.md | Rewrites EN module creation guide with step-by-step example and APIs. |
| docs/site/en/guide/contributing.md | Adds EN contribution guide (workflow, tooling, tests). |
| docs/site/en/guide/configuration.md | Rewrites EN configuration guide with field types, persistence, admin UI flow. |
| docs/site/en/guide/commands.md | Rewrites EN commands guide with options/autocomplete/propagation details. |
| docs/site/en/guide/architecture.md | Adds EN architecture overview (boot, loaders, registry, dispatch). |
| docs/site/.vitepress/config.ts | Updates sidebar navigation to include architecture, contributing, and legal pages (EN + FR). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ls, and expanded content
- contributing: commitlint runs in commit-msg hook, not pre-commit - commands: include all 5 Discord.js builder types in Command.data - interactions: config is required (not optional) in check signature - config: localize French sidebar 'Legal' -> 'Juridique'
- Add note about Core module config in autocomplete handlers - Fix service testability advice to recommend exporting the class - Add missing imports to interaction example snippets
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Complete documentation rewrite for newcomers. Adds setup instructions, architecture overview, contribution guide, privacy policy, and terms of service.
Commits