Skip to content

Conversation

@ellyxir
Copy link
Contributor

@ellyxir ellyxir commented Oct 22, 2025

  • Add docs/common/RUNTIME.md - comprehensive guide for runtime development (servers, testing, integration tests, debugging)
  • Add docs/common/RECIPE_DEPLOYMENT.md - extracted recipe/pattern deployment workflows and ct commands from DEVELOPMENT.md
  • Add DEVELOPMENT.md general coding standards, design principles, and best practices (removed recipe-specific deployment content)
  • Move packages/patterns/README.md -> docs/common/UI_TESTING.md

Summary by cubic

Cleaned up AGENTS.md and consolidated development guidance into dedicated docs for runtime, recipe deployment, and general standards. This reduces duplication and makes it easier to find the right guide for building and testing recipes and runtime code.

  • New Features

    • Added docs/common/RUNTIME.md for running servers, testing, and integration tests.
    • Added docs/common/RECIPE_DEPLOYMENT.md for ct CLI workflows to deploy and iterate on recipes.
    • Added docs/common/DEVELOPMENT.md for coding standards and design principles.
  • Refactors

    • Trimmed AGENTS.md to point to the new docs and clarified the defunct top-level recipes folder.
    • Moved packages/patterns/README.md to docs/common/UI_TESTING.md.

- Add docs/common/RUNTIME.md - comprehensive guide for runtime development
    (servers, testing, integration tests, debugging)
- Add docs/common/RECIPE_DEV_DEPLOY.md - build, debug, deploy pattern
- Add DEVELOPMENT.md general coding standards, design principles, and best
    practices (removed recipe-specific deployment content)
- Move packages/patterns/README.md -> docs/common/UI_TESTING.md
@ellyxir ellyxir force-pushed the ellyse/agent-md-cleanup branch from 6e2b645 to 8b78344 Compare October 22, 2025 19:58
@ellyxir ellyxir marked this pull request as ready for review October 22, 2025 19:58
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 issues found across 6 files

Prompt for AI agents (all 4 issues)

Understand the root cause of the following 4 issues and fix them.


<file name="docs/common/PATTERNS.md">

<violation number="1" location="docs/common/PATTERNS.md:743">
The reference uses `./common/doc/...`, but only docs/common/RECIPE_DEV_DEPLOY.md exists, so the path is broken. Point directly to the existing doc so readers can reach it.</violation>
</file>

<file name="docs/common/DEVELOPMENT.md">

<violation number="1" location="docs/common/DEVELOPMENT.md:170">
Enum members should not end with a semicolon; use a comma or remove the delimiter so the snippet matches valid TypeScript.</violation>

<violation number="2" location="docs/common/DEVELOPMENT.md:227">
Replace the colon in this console.error call with a comma so the sample compiles.</violation>

<violation number="3" location="docs/common/DEVELOPMENT.md:310">
Provide type arguments when aliasing Map so the example reflects valid TypeScript.</violation>
</file>

React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.

@ellyxir ellyxir merged commit f2f3a85 into main Oct 22, 2025
8 checks passed
@ellyxir ellyxir deleted the ellyse/agent-md-cleanup branch October 22, 2025 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants