Add docs to connect to remote JVM instance #339
Conversation
WalkthroughThe changes update the documentation in Changes
Possibly related PRs
Suggested reviewers
Poem
Warning Review ran into problems🔥 ProblemsGitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository. Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@nikhil-zlai Sorry I merged the previous PR too quickly before updating the docs :) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
devnotes.md (2)
444-444: Clarify commit message note.
Consider rephrasing for clarity, e.g., "Note: The quotes are necessary for multi-word commit messages."🧰 Tools
🪛 LanguageTool
[uncategorized] ~444-~444: Possible missing article found.
Context: ...`` > Note: The quotes are necessary for multi-word commit message. ## Connect remote...(AI_HYDRA_LEO_MISSING_A)
445-453: Review remote JVM debugging section.
The new section clearly outlines the steps. However, please fix the typo "remorte debugging" to "remote debugging."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)
📒 Files selected for processing (1)
devnotes.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
devnotes.md
[uncategorized] ~444-~444: Possible missing article found.
Context: ...`` > Note: The quotes are necessary for multi-word commit message. ## Connect remote...
(AI_HYDRA_LEO_MISSING_A)
sean-zlai
force-pushed
the
sean/remote-jvm-debug-notes
branch
from
72baf24 to
7d8dfd0
Compare
|
@ken-zlai great feedback. I've fixed the typo and added to the list. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
devnotes.md (1)
446-461: Remote Debugging Section
The new section is well structured and easy to follow. Consider adding a brief summary at the top to explain the benefit of remote debugging. Also, update "etc" to "etc." for proper American English punctuation.Suggested diff:
-... when some code in the frontend is run (i.e. api call, etc) +... when some code in the frontend is run (i.e. api call, etc.)🧰 Tools
🪛 LanguageTool
[style] ~448-~448: In American English, abbreviations like “etc.” require a period.
Context: ... in the frontend is run (i.e. api call, etc) To connect to the process within the ...(ETC_PERIOD)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)
📒 Files selected for processing (1)
devnotes.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
devnotes.md
[style] ~448-~448: In American English, abbreviations like “etc.” require a period.
Context: ... in the frontend is run (i.e. api call, etc) To connect to the process within the ...
(ETC_PERIOD)
🔇 Additional comments (1)
devnotes.md (1)
444-445: Commit Message Note Clarity
The note on using quotes for multi-word commit messages is clear and concise.
## Summary
## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Added a new section for connecting remotely to a Java process in
Docker using IntelliJ's remote debugging feature.
- Clarified commit message formatting instructions for better
consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->
---------
Co-authored-by: Sean Lynch <[email protected]>
## Summary
## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Added a new section for connecting remotely to a Java process in
Docker using IntelliJ's remote debugging feature.
- Clarified commit message formatting instructions for better
consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->
---------
Co-authored-by: Sean Lynch <[email protected]>
## Summary
## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Added a new section for connecting remotely to a Java process in
Docker using IntelliJ's remote debugging feature.
- Clarified commit message formatting instructions for better
consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->
---------
Co-authored-by: Sean Lynch <[email protected]>
## Summary
## Checklist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Added a new section for connecting remotely to a Java process in
Docker using IntelliJ's remote debugging feature.
- Clarified commit message formatting instructions for better
consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to track
the status of stacks when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->
---------
Co-authored-by: Sean Lynch <[email protected]>
## Summary
## Cheour clientslist
- [ ] Added Unit Tests
- [ ] Covered by existing CI
- [ ] Integration tested
- [ ] Documentation update
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Added a new section for connecting remotely to a Java process in
Doour clientser using IntelliJ's remote debugging feature.
- Clarified commit message formatting instructions for better
consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- av pr metadata
This information is embedded by the av CLI when creating PRs to traour clients
the status of staour clientss when using Aviator. Please do not delete or edit
this section of the PR.
```
{"parent":"main","parentHead":"","trunk":"main"}
```
-->
---------
Co-authored-by: Sean Lynch <[email protected]>
Summary
Checklist
Summary by CodeRabbit