-
Notifications
You must be signed in to change notification settings - Fork 9
clean up AGENTS.md, mostly pointing to other docs #1935
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
ddcc037 to
29f6915
Compare
29f6915 to
4f0afc8
Compare
- 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
4f0afc8 to
66d05da
Compare
b5a03de to
6e2b645
Compare
6e2b645 to
8b78344
Compare
There was a problem hiding this 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.
… is a fallback for other llms
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.
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
Refactors