-
Notifications
You must be signed in to change notification settings - Fork 163
Add AGENTS.md #892
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
Add AGENTS.md #892
Conversation
📝 WalkthroughWalkthroughA new comprehensive documentation file is added to describe the LiveKit Swift SDK architecture, key components, dependencies, testing suites, threading guidelines, error handling, coding conventions, and platform-specific considerations, without introducing any code or public API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
|
|
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.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@AGENTS.md`:
- Line 21: The fenced code block that shows the repository tree starting with
"Sources/LiveKit/" is missing a language tag; update the opening fence to
include a language (use `text`) so the block becomes ```text (leave the closing
``` as-is) to satisfy MD040 and markdownlint.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
AGENTS.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
AGENTS.md
21-21: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (21)
- GitHub Check: Build & Test (macos-15, 16.4, macOS)
- GitHub Check: Build & Test (macos-14, 15.4, tvOS Simulator,name=Apple TV,OS=17.5)
- GitHub Check: Build & Test (macos-26, 26.1, macOS, true)
- GitHub Check: Build & Test (macos-26, 26.1, visionOS Simulator,name=Apple Vision Pro,OS=26.1)
- GitHub Check: Build & Test (macos-26, 26.1, macOS, true)
- GitHub Check: Build & Test (macos-26, 26.1, tvOS Simulator,name=Apple TV,OS=26.1)
- GitHub Check: Build & Test (macos-15, 16.4, tvOS Simulator,name=Apple TV,OS=18.5)
- GitHub Check: Build & Test (macos-14, 15.4, iOS Simulator,name=iPhone 15 Pro,OS=17.5)
- GitHub Check: Build & Test (macos-26, 26.1, macOS,variant=Mac Catalyst)
- GitHub Check: Build & Test (macos-14, 15.4, macOS)
- GitHub Check: Build & Test (macos-26, 26.1, iOS Simulator,name=iPhone 17 Pro,OS=26.1, true)
- GitHub Check: Build & Test (macos-15, 16.4, macOS,variant=Mac Catalyst)
- GitHub Check: Build & Test (macos-15, 16.4, visionOS Simulator,name=Apple Vision Pro,OS=2.5)
- GitHub Check: Build & Test (macos-26, 26.1, iOS Simulator,name=iPhone 17 Pro,OS=26.1, true)
- GitHub Check: Build & Test (macos-26, 26.1, macOS, true)
- GitHub Check: Build & Test (macos-15, 16.4, iOS Simulator,name=iPhone 16 Pro,OS=18.5)
- GitHub Check: Build & Test (macos-14, 15.4, macOS,variant=Mac Catalyst)
- GitHub Check: lint (macos-15, 16.4)
- GitHub Check: lint (macos-14, 15.4)
- GitHub Check: lint (macos-26, 26.1)
- GitHub Check: Analyze (swift)
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
|
|
||
| ## Architecture | ||
|
|
||
| ``` |
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.
Add a language tag to the fenced block.
Markdownlint flags the fence at Line 21 as missing a language spec. Consider text to satisfy MD040.
✅ Proposed fix
-```
+```text
Sources/LiveKit/
├── Core/ # Room, SignalClient, Transport (WebRTC peer connections)
...
└── Protos/ # Generated protobuf types (excluded from linting)
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
21-21: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@AGENTS.md` at line 21, The fenced code block that shows the repository tree
starting with "Sources/LiveKit/" is missing a language tag; update the opening
fence to include a language (use `text`) so the block becomes ```text (leave the
closing ``` as-is) to satisfy MD040 and markdownlint.
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.
@coderabbitai fix
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.
@pblazej, I'll fix the missing language tag in the fenced code block.
Task: Add language tag to fenced code block
- Update the opening fence at Line 21 to include
textlanguage identifier to satisfy MD040 markdownlint rule
💡 For code changes across multiple files, use @coderabbitai plan in an issue comment
Also adds https://github.com/AvdLee/Swift-Concurrency-Agent-Skill ⚔️
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.