chore(docs): consolidate agent docs to single source of truth

- Delete legacy .cursorrules, .windsurfrules, .clinerules, CLAUDE.md
  (content duplicated AGENTS.md; replaced by canonical pointer architecture)
- Rewrite .github/copilot-instructions.md as thin pointer to AGENTS.md
  and the canonical agent-behavior-guidelines.md
- Prepend canonical 'Read first' pointer block to AGENTS.md
- Regenerate .editorconfig and .aider.conf.yml

Canonical source: learning_ai_common_plat/AI.dev/SKILLS/agent-behavior-guidelines.md
Managed by: learning_ai_common_plat/scripts/update-agent-docs.sh
This commit is contained in:
saravanakumardb1 2026-05-23 11:53:22 -07:00
parent 7ea2c480e9
commit 479894446a
7 changed files with 29 additions and 145 deletions

View File

@ -1,5 +1,6 @@
# .aider.conf.yml — Aider Configuration for ByteLyst Agentic Notes # .aider.conf.yml — Aider Configuration for ByteLyst Agentic Notes
# Helps Aider understand the project structure and conventions. # Auto-generated by learning_ai_common_plat/scripts/update-agent-docs.sh
# Hand-edit will be overwritten on next run.
read: read:
- AGENTS.md - AGENTS.md

View File

@ -1,22 +0,0 @@
# .clinerules — Cline / Roo Code Rules for ByteLyst Agentic Notes
# Read AGENTS.md for the complete onboarding guide.
## Project: ByteLyst Agentic Notes — Agentic note-taking workspace for notes, tasks, relationships, and workspaces
Architecture: Docs + Fastify 5 backend scaffold with TypeScript ESM and @bytelyst/* shared packages
## Mandatory Rules
- Backend follows the ByteLyst product-backend pattern with Fastify 5 + TypeScript ESM
- Use @bytelyst/* shared packages instead of reimplementing common infrastructure
- Fastify modules follow types.ts → repository.ts → routes.ts
- Use req.log / app.log — never console.log
- Every Cosmos document MUST include productId: "bytelyst-notes"
- Keep docs aligned with implementation as the repo evolves from scaffold to product
- Commits: `type(scope): description`
- After changes, verify: `cd backend && npm test && npm run typecheck && npm run build`
## Key File Locations
- docs/ — PRD, roadmap, and planning docs
- backend/ — Fastify 5 + TypeScript ESM backend scaffold (port 4016)
- backend/src/modules/ — notes, workspaces, note-relationships, note-tasks
- backend/src/lib/ — shared backend wiring and utilities
- Full guide: `AGENTS.md`

View File

@ -1,30 +0,0 @@
# ByteLyst Agentic Notes — Cursor Rules
# Read AGENTS.md for full context.
Project: ByteLyst Agentic Notes — Agentic note-taking workspace for notes, tasks, relationships, and workspaces
Product ID: bytelyst-notes
Stack: Docs + Fastify 5 backend scaffold with TypeScript ESM and @bytelyst/* shared packages
## Architecture
- docs/ — PRD, roadmap, and planning docs
- backend/ — Fastify 5 + TypeScript ESM backend scaffold (port 4016)
- backend/src/modules/ — notes, workspaces, note-relationships, note-tasks
- backend/src/lib/ — shared backend wiring and utilities
## Rules
- Backend follows the ByteLyst product-backend pattern with Fastify 5 + TypeScript ESM
- Use @bytelyst/* shared packages instead of reimplementing common infrastructure
- Fastify modules follow types.ts → repository.ts → routes.ts
- Use req.log / app.log — never console.log
- Every Cosmos document MUST include productId: "bytelyst-notes"
- Keep docs aligned with implementation as the repo evolves from scaffold to product
- Commits: feat(scope): description / fix(scope): description
- Never delete existing comments/documentation unless asked
- Never add emojis unless asked
- Never hardcode secrets, colors, or API URLs
## Build Verification
- cd backend && npm test && npm run typecheck && npm run build
## Key Documents
- AGENTS.md — Full AI agent instructions (read this first)

View File

@ -1,38 +1,24 @@
# GitHub Copilot Instructions — NoteLett <!-- AUTO-GENERATED by learning_ai_common_plat/scripts/update-agent-docs.sh -->
<!-- DO NOT EDIT. Edit the canonical sources instead. -->
> For full agent instructions, read [`AGENTS.md`](../AGENTS.md) at the repo root. # GitHub Copilot Instructions — ByteLyst Agentic Notes
## Project Context **Project:** ByteLyst Agentic Notes — `bytelyst-notes`
**Stack:** Docs + Fastify 5 backend scaffold with TypeScript ESM and @bytelyst/* shared packages
**NoteLett** — structured notes platform for humans and AI agents. ## Read these (in order) before suggesting code
Stack: Fastify 5 + TypeScript ESM backend, Next.js web, Expo mobile, and @bytelyst/* shared packages
## Code Generation Rules 1. **`AGENTS.md`** at the repo root — repo-specific layout, conventions,
build commands, file ownership.
2. **`../learning_ai_common_plat/AI.dev/SKILLS/agent-behavior-guidelines.md`** —
ecosystem-wide agent behavior rules (Karpathy + ByteLyst). Identical
across every repo in the workspace.
### Always Both files together are the complete contract. This pointer file contains
- Backend follows the ByteLyst product-backend pattern with Fastify 5 + TypeScript ESM no rules of its own to avoid duplication and drift.
- Use @bytelyst/* shared packages instead of reimplementing common infrastructure
- Fastify modules follow types.ts → repository.ts → routes.ts
- Use req.log / app.log — never console.log
- Every Cosmos document MUST include productId: "notelett"
- Keep docs aligned with implementation as the repo evolves from scaffold to product
- Include `productId: "notelett"` in every Cosmos DB document
- Use `type(scope): description` commit message format
- Fix source code, not tests (unless the test itself is wrong)
### Never ## Quick verification command
- `console.log` or `print()` in production code
- Hardcoded secrets, API keys, colors, or URLs
- Delete existing comments or documentation unless explicitly asked
- Add emojis unless asked
## Key Paths
- docs/ — PRD, roadmap, and planning docs
- backend/ — Fastify 5 + TypeScript ESM backend (port 4016)
- backend/src/modules/ — notes, workspaces, relationships, tasks, artifacts, reviews, prompts, intake, palace, and sharing
- backend/src/lib/ — shared backend wiring and utilities
## Build Verification
```bash ```bash
pnpm run verify cd backend && npm test && npm run typecheck && npm run build
``` ```

View File

@ -1,23 +0,0 @@
# ByteLyst Agentic Notes — Windsurf / Codeium Rules
# Read AGENTS.md for full context. These are the critical rules.
Project: ByteLyst Agentic Notes — Agentic note-taking workspace for notes, tasks, relationships, and workspaces
Stack: Docs + Fastify 5 backend scaffold with TypeScript ESM and @bytelyst/* shared packages
## Architecture Rules
- docs/ — PRD, roadmap, and planning docs
- backend/ — Fastify 5 + TypeScript ESM backend scaffold (port 4016)
- backend/src/modules/ — notes, workspaces, note-relationships, note-tasks
- backend/src/lib/ — shared backend wiring and utilities
## Conventions
- Backend follows the ByteLyst product-backend pattern with Fastify 5 + TypeScript ESM
- Use @bytelyst/* shared packages instead of reimplementing common infrastructure
- Fastify modules follow types.ts → repository.ts → routes.ts
- Use req.log / app.log — never console.log
- Every Cosmos document MUST include productId: "bytelyst-notes"
- Keep docs aligned with implementation as the repo evolves from scaffold to product
- Commits: feat(scope): description / fix(scope): description
## Build Verification
- cd backend && npm test && npm run typecheck && npm run build

View File

@ -1,5 +1,17 @@
# AGENTS.md — AI Coding Agent Instructions # AGENTS.md — AI Coding Agent Instructions
<!-- BEGIN: canonical-behavior-pointer (auto-managed) -->
> **Read first (ecosystem-wide agent behavior):**
> [`../learning_ai_common_plat/AI.dev/SKILLS/agent-behavior-guidelines.md`](../learning_ai_common_plat/AI.dev/SKILLS/agent-behavior-guidelines.md)
>
> The link above is the single source of truth for agent behavior across every
> ByteLyst repo (Karpathy + ByteLyst rules: tests sacred, verify before done,
> no shared-infra hand-edits, no `console.log`/`print`, productId on every
> Cosmos doc, conventional commits, style preservation).
>
> The per-repo content below extends — never duplicates — the canonical rules.
<!-- END: canonical-behavior-pointer -->
> **For:** Claude Code, OpenAI Codex, Cursor, GitHub Copilot, Windsurf Cascade, and any AI coding agent. > **For:** Claude Code, OpenAI Codex, Cursor, GitHub Copilot, Windsurf Cascade, and any AI coding agent.
> **Repo:** `learning_ai_notes` — NoteLett structured notes platform for humans and AI agents. > **Repo:** `learning_ai_notes` — NoteLett structured notes platform for humans and AI agents.
> **See also:** [`docs/PRD.md`](docs/PRD.md) for full product spec, [`docs/ROADMAP.md`](docs/ROADMAP.md) for implementation status, [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for the production-readiness checklist, and [`docs/UI_UX_PLATFORM_CORE_ROADMAP.md`](docs/UI_UX_PLATFORM_CORE_ROADMAP.md) for UI/UX platform-core migration. > **See also:** [`docs/PRD.md`](docs/PRD.md) for full product spec, [`docs/ROADMAP.md`](docs/ROADMAP.md) for implementation status, [`docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md`](docs/PRODUCTION_READINESS_HANDOFF_ROADMAP.md) for the production-readiness checklist, and [`docs/UI_UX_PLATFORM_CORE_ROADMAP.md`](docs/UI_UX_PLATFORM_CORE_ROADMAP.md) for UI/UX platform-core migration.

View File

@ -1,40 +0,0 @@
# ByteLyst Agentic Notes — Claude Code Instructions
> This file is read automatically by Claude Code. For full agent instructions
> shared across all AI tools, see [`AGENTS.md`](AGENTS.md).
## Quick Context
**Product:** ByteLyst Agentic Notes — Agentic note-taking workspace for notes, tasks, relationships, and workspaces
**Product ID:** `bytelyst-notes`
**Stack:** Docs + Fastify 5 backend scaffold with TypeScript ESM and @bytelyst/* shared packages
## Rules
1. **Read `AGENTS.md` first** — it has coding conventions, file ownership, and tech stack rules.
2. **Every Cosmos document** must have a `productId: "bytelyst-notes"` field.
3. **Commit messages:** `type(scope): description` (feat, fix, docs, refactor, test, chore).
4. **Fix source, not tests** — unless the test itself is wrong.
5. **Never use** `console.log`, `print()`, or hardcoded colors/secrets/URLs.
## Architecture
- docs/ — PRD, roadmap, and planning docs
- backend/ — Fastify 5 + TypeScript ESM backend scaffold (port 4016)
- backend/src/modules/ — notes, workspaces, note-relationships, note-tasks
- backend/src/lib/ — shared backend wiring and utilities
## Build Verification
```bash
pnpm --filter @notelett/backend run test
pnpm --filter @notelett/backend run typecheck
pnpm --filter @notelett/backend run build
```
---
## Cross-Repo Automation
See [`../learning_ai_common_plat/docs/devops/CODING_AGENT_AUTOMATION_PLAYBOOK.md`](../learning_ai_common_plat/docs/devops/CODING_AGENT_AUTOMATION_PLAYBOOK.md) for periodic maintenance tasks: test audits, coverage gaps, dependency checks, secret scans, typecheck sweeps.