ENG-1289 - Migrate .cursor/rules to AGENTS.md (#702)

* Migrate cursor rules to agents

* Add documentation and testing guidance

Author: mdroidian

.cursor/rules/roam.mdc

@@ -1,8 +1,3 @@
----
-description: 
-globs: 
-alwaysApply: true
----
 You are an expert senior software engineer specializing in modern web development, with deep expertise in TypeScript, React, Next.js (App Router), and Tailwind CSS. You are thoughtful, precise, and focus on delivering high-quality, maintainable solutions.
 
 This repository uses Turborepo.
@@ -31,23 +26,23 @@ This repository uses Turborepo.
 - Use platform-native UI components (see below) first with shadcn/ui as a fallback
 - Maintain visual consistency with the host application's design system
 - Follow responsive design principles
-  
+
 ### TypeScript Guidelines
 
 - Prefer `type` over `interface`
 - Use explicit return types for functions
 - Avoid `any` types when possible
 - Prefer arrow functions over regular function declarations
 - Use named parameters (object destructuring) when a function has more than 2 parameters
-  
+
 ### Code Formatting
 
 - Use Prettier with the project's configuration
 - Maintain consistent naming conventions:
   - PascalCase for components and types
   - camelCase for variables and functions
   - UPPERCASE for constants
- 
+
 ### Code Organization
 
 - Prefer small, focused functions over inline code
@@ -56,4 +51,15 @@ This repository uses Turborepo.
 - Choose descriptive function names that make comments unnecessary
 - Break down complex operations into smaller, meaningful functions
 - Prefer early returns over nested conditionals for better readability
-- Prefer util functions for reusable logic and common operations
+- Prefer util functions for reusable logic and common operations
+
+### Documentation
+
+- Add comments only when necessary; descriptive names should minimize the need for comments
+- Explain the why, not the what, focusing on reasoning, trade-offs, and approaches
+- Document limitations, known bugs, or edge cases where behavior may not align with expectations
+
+### Testing
+
+- Write unit tests for new functionality
+- Ensure tests are meaningful and maintainable

.cursor/rules/website.mdc

@@ -1,18 +1,13 @@
----
-description: 
-globs: apps/obsidian/**
-alwaysApply: false
----
 You are working on the Obsidian plugin that implements the Discourse Graph protocol.
 
-## dependencies
-prefer existing depedencies from [package.json](mdc:apps/obsidian/package.json)
+## Dependencies
+Prefer existing dependencies from package.json.
 
 ## Obsidian Style Guide
-Use the obsidian style guide from help.obsidian.md/style-guide and docs.obsidian.md/Developer+policies
+Use the obsidian style guide from help.obsidian.md/style-guide and docs.obsidian.md/Developer+policies.
 
-### Icons 
-platform-native UI
+### Icons
+Platform-native UI.
 Lucide and custom Obsidian icons can be used alongside detailed elements to provide a visual representation of a feature.
 
 Example: In the ribbon on the left, select Create new canvas ( lucide-layout-dashboard.svg > icon ) to create a canvas in the same folder as the active file.
@@ -26,7 +21,7 @@ Example: The icon for creating a new canvas should be named lucide-layout-dashbo
 
 Use the SVG version of the icons available.
 Icons should be 18 pixels in width, 18 pixels in height, and have a stroke width of 1.5. You can adjust these settings in the SVG data.
-Adjusting size and stroke in an SVG
+Adjusting size and stroke in an SVG.
 Utilize the icon anchor in embedded images, to tweak the spacing around the icon so that it aligns neatly with the text in the vicinity.
 Icons should be surrounded by parenthesis. ( lucide-cog.svg > icon )
-Example: ( ![[lucide-cog.svg#icon]] )
+Example: ( ![[lucide-cog.svg#icon]] )

.cursor/rules/main.mdc AGENTS.md.cursor/rules/main.mdc renamed to AGENTS.md

@@ -0,0 +1,10 @@
+You are working on the Roam Research extension that implements the Discourse Graph protocol.
+
+## Dependencies
+Prefer existing dependencies from package.json.
+
+## Roam Style Guide
+
+Platform-native UI - use BlueprintJS 3 components and Tailwind CSS.
+Use the roamAlphaApi docs from https://roamresearch.com/#/app/developer-documentation/page/tIaOPdXCj.
+Use Roam Depot/Extension API docs from https://roamresearch.com/#/app/developer-documentation/page/y31lhjIqU.

.cursor/rules/obsidian.mdc apps/obsidian/AGENTS.md.cursor/rules/obsidian.mdc renamed to apps/obsidian/AGENTS.md

@@ -0,0 +1,4 @@
+You are working on the public-facing website for Discourse Graph.
+
+## Dependencies
+Prefer existing dependencies from package.json.

apps/roam/AGENTS.md

@@ -1,6 +1 @@
----
-description: 
-globs: apps/website/app/api/**
-alwaysApply: false
----
 You are working on the api routes for Discourse Graph which uses NextJS app router.