This repository was archived by the owner on Jul 13, 2026. It is now read-only.
feat: onboard docs, agent instructions, and RAG configuration - #1
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a full documentation corpus plus repo-level onboarding guidance for a local Supabase-backed RAG setup.
Changes:
- Introduces extensive Markdown documentation under
docs/(concepts, CLI, channels, automation). - Updates root docs (
README.md,AGENTS.md) to describe repo structure and usage. - Adds i18n glossary assets and docs site metadata (e.g.,
docs/CNAME).
Reviewed changes
Copilot reviewed 101 out of 418 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/concepts/markdown-formatting.md | Documents IR-based markdown formatting pipeline and chunking rules |
| docs/concepts/features.md | Adds product feature overview page |
| docs/concepts/context.md | Explains context composition and inspection commands |
| docs/concepts/compaction.md | Describes context compaction behavior and configuration |
| docs/concepts/architecture.md | Documents gateway architecture and protocol overview |
| docs/concepts/agent.md | Describes agent runtime, workspace contract, and streaming/queue semantics |
| docs/concepts/agent-workspace.md | Defines workspace layout, backup, and migration guidance |
| docs/concepts/agent-loop.md | Walkthrough of the agent loop lifecycle and hooks |
| docs/cli/webhooks.md | CLI reference for webhook helpers and Gmail Pub/Sub |
| docs/cli/voicecall.md | CLI reference for voicecall plugin command surface |
| docs/cli/update.md | CLI reference for updating channels/tags and restart behavior |
| docs/cli/uninstall.md | CLI reference for uninstalling gateway service and data |
| docs/cli/tui.md | CLI reference for terminal UI connectivity and flags |
| docs/cli/system.md | CLI reference for system events, heartbeat, and presence |
| docs/cli/status.md | CLI reference for health/diagnostics and deep probes |
| docs/cli/skills.md | CLI reference for skills list/info/check |
| docs/cli/setup.md | CLI reference for initialization and wizard entrypoint |
| docs/cli/sessions.md | CLI reference for listing sessions and cleanup maintenance |
| docs/cli/security.md | CLI reference for security audit and fix behavior |
| docs/cli/secrets.md | CLI reference for SecretRef management commands |
| docs/cli/sandbox.md | CLI reference for sandbox inspection and container management |
| docs/cli/reset.md | CLI reference for resetting local state |
| docs/cli/qr.md | CLI reference for generating pairing QR/setup code |
| docs/cli/plugins.md | CLI reference for plugin management and install/update rules |
| docs/cli/pairing.md | CLI reference for pairing list/approve flows |
| docs/cli/onboard.md | CLI reference for onboarding wizard (interactive/non-interactive) |
| docs/cli/nodes.md | CLI reference for node listing/approval and command execution |
| docs/cli/node.md | CLI reference for headless node host run/install |
| docs/cli/models.md | CLI reference for models status/list/set/scan and auth profiles |
| docs/cli/memory.md | CLI reference for memory indexing/search |
| docs/cli/logs.md | CLI reference for tailing gateway logs over RPC |
| docs/cli/hooks.md | CLI reference for managing internal hooks |
| docs/cli/health.md | CLI reference for gateway health RPC |
| docs/cli/gateway.md | CLI reference for gateway run/query/discovery/service management |
| docs/cli/doctor.md | CLI reference for guided repairs and integrity checks |
| docs/cli/docs.md | CLI reference for searching live docs index |
| docs/cli/dns.md | CLI reference for wide-area discovery helpers |
| docs/cli/directory.md | CLI reference for channel directory/id lookup |
| docs/cli/devices.md | CLI reference for device pairing/token rotation |
| docs/cli/dashboard.md | CLI reference for opening Control UI safely |
| docs/cli/daemon.md | Documents legacy alias for gateway service management |
| docs/cli/cron.md | CLI reference for cron scheduling and run behavior |
| docs/cli/configure.md | CLI reference for interactive configuration wizard |
| docs/cli/config.md | CLI reference for non-interactive config get/set/validate |
| docs/cli/completion.md | CLI reference for shell completion generation/install |
| docs/cli/clawbot.md | Documents legacy alias namespace |
| docs/cli/channels.md | CLI reference for channel account management and probes |
| docs/cli/browser.md | CLI reference for browser control and extension relay |
| docs/cli/backup.md | CLI reference for backup creation and verification |
| docs/cli/approvals.md | CLI reference for exec approvals management |
| docs/cli/agents.md | CLI reference for agent management and routing bindings |
| docs/cli/agent.md | CLI reference for sending a single agent turn |
| docs/cli/acp.md | Documents ACP bridge usage for IDE integrations |
| docs/ci.md | Documents CI job graph, scope logic, and local equivalents |
| docs/channels/zalouser.md | Channel guide for Zalo personal account plugin |
| docs/channels/zalo.md | Channel guide for Zalo Bot API plugin |
| docs/channels/troubleshooting.md | Cross-channel troubleshooting ladder and signatures |
| docs/channels/tlon.md | Channel guide for Tlon/Urbit plugin |
| docs/channels/synology-chat.md | Channel guide for Synology Chat webhook plugin |
| docs/channels/pairing.md | Pairing overview for DMs and device nodes |
| docs/channels/nostr.md | Channel guide for Nostr DM plugin |
| docs/channels/nextcloud-talk.md | Channel guide for Nextcloud Talk webhook plugin |
| docs/channels/location.md | Documents location parsing normalization and context fields |
| docs/channels/line.md | Channel guide for LINE Messaging API plugin |
| docs/channels/irc.md | Channel guide for IRC plugin configuration and access control |
| docs/channels/index.md | Index of supported chat channels |
| docs/channels/group-messages.md | Documents group message handling and mention gating |
| docs/channels/channel-routing.md | Documents deterministic routing and session key shapes |
| docs/brave-search.md | Documents Brave Search API setup and tool parameters |
| docs/automation/webhook.md | Documents webhook ingress endpoints, auth, mappings, and policies |
| docs/automation/troubleshooting.md | Troubleshooting for cron/heartbeat scheduling and delivery |
| docs/automation/poll.md | Documents poll sending via CLI/RPC/tool and channel differences |
| docs/automation/gmail-pubsub.md | End-to-end wiring for Gmail Pub/Sub to OpenClaw hooks |
| docs/automation/auth-monitoring.md | Documents OAuth expiry monitoring via CLI and scripts |
| docs/auth-credential-semantics.md | Defines canonical auth credential eligibility/resolution semantics |
| docs/CNAME | Sets docs site custom domain |
| docs/.i18n/glossary.zh-CN.json | Adds Chinese glossary term mappings for i18n pipeline |
| docs/.i18n/glossary.ja-JP.json | Adds Japanese glossary term mappings for i18n pipeline |
| docs/.i18n/README.md | Documents i18n asset formats and generation behavior |
| README.md | Replaces prior README with repo-focused RAG + Supabase usage guide |
| AGENTS.md | Adds repo-specific agent contribution and safety guidelines |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's foundational elements by establishing a robust documentation framework and integrating essential Retrieval-Augmented Generation (RAG) components. It aims to streamline the onboarding process for new users and agents, ensuring clarity in operational guidelines and providing the necessary infrastructure for local RAG development and deployment. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8fb0b15799
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly enhances the project's documentation by adding a comprehensive set of guides, agent instructions, and configuration details. The new README.md is a great improvement, providing a clear and structured overview. The added documentation for automation, channels, CLI, and concepts will be very valuable for users and contributors. I have one suggestion to improve the clarity of the setup instructions in the README.md for users on different operating systems.
Owner
Author
|
/review |
Owner
Author
|
@copilot-pull-request-reviewer @chatgpt-codex-connector @gemini-code-assist /review I have addressed all the feedback and resolved the threads. Please re-review the PR. |
|
Codex Review: Didn't find any major issues. Bravo. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive documentation suite and the initial implementation for the DOC-KB-RAG system. The changes include documentation for setup, architecture, and CLI commands, as well as Python scripts for document ingestion and querying using a RAG pipeline with Supabase and Gemini models. I have reviewed the added documentation and code and have not identified any issues of medium or higher severity.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR introduces the documentation corpus, agent instructions, and local Supabase/RAG configurations.
Changes included: