Added .md files for coding assistant#210
Open
CoderOMaster wants to merge 2 commits intomainfrom
Open
Conversation
CoderOMaster
requested review from
HarshaNalluru,
r4ghu and
yatharthk2
as code owners
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository guidance files intended for AI coding assistants and updates gitignore rules so the guidance can be committed and tracked.
Changes:
- Added
AGENTS.mdwith repo overview, layout, commands, architecture notes, and CI/testing guidance for agents. - Added
CLAUDE.md(currently a one-line reference toAGENTS.md). - Updated
.gitignoreto stop ignoringCLAUDE.md.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CLAUDE.md |
Introduces a Claude-specific entrypoint file (currently only references AGENTS.md). |
AGENTS.md |
Adds agent-facing documentation for repo structure, workflows, and SDK patterns. |
.gitignore |
Allows CLAUDE.md to be committed by removing the ignore pattern. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
Comment on lines
+65
to
+66
| npm run type-check # TS type check across examples/javascript and apps/next-js | ||
| npm run lint # eslint across examples/javascript and apps/next-js |
| ## Testing Notes | ||
|
|
||
| - E2E and integration tests require `MOSS_PROJECT_ID` and `MOSS_PROJECT_KEY`; they auto-skip gracefully when credentials are absent | ||
| - CI runs Python tests across versions 3.10–3.14 using tox |
yatharthk2
reviewed
May 6, 2026
|
|
||
| Moss is a real-time semantic search runtime for AI agents targeting sub-10ms query latency. The runtime runs on-device using bundled embedding models (`moss-minilm`) — no external embedding API calls are needed. The cloud layer handles project management and index distribution; the local layer handles querying. | ||
|
|
||
| This repository contains the **multi-language SDKs**, **framework integrations** (cookbooks), and **application examples**. It is NOT the core Rust engine — that ships as pre-compiled native bindings (`inferedge-moss-core` / `@moss-dev/moss-core` / `moss_core`). |
Collaborator
There was a problem hiding this comment.
do we require, "It is NOT the core Rust engine — that ships as pre-compiled native bindings (inferedge-moss-core / @moss-dev/moss-core / moss_core)."
Comment on lines
+20
to
+30
| javascript/ — Standalone TS usage examples | ||
| cookbook/ — Framework integrations (LangChain, DSPy, Pipecat, etc.) | ||
| apps/ | ||
| next-js/ — Next.js semantic search UI | ||
| pipecat-moss/ — Pipecat voice agent integration | ||
| livekit-moss-vercel/ — LiveKit + Vercel voice agent | ||
| packages/ | ||
| vitepress-plugin-moss/ — VitePress search plugin | ||
| vercel-sdk/ — Vercel AI SDK integration | ||
| pipecat-moss/ — Pipecat Python package | ||
| moss-cli/ — CLI tools for index management |
Collaborator
There was a problem hiding this comment.
is this covering all ? i feel many are missing
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.
Pull Request Checklist
Please ensure that your PR meets the following requirements:
Description
Added agents.md and claude.md file