docs(arc-api): add CLI page #136
Conversation
| @@ -0,0 +1,3 @@ | |||
| title: Packages | |||
| nav: | |||
There was a problem hiding this comment.
@Tyagi-Sunny Sir,this adds a single navigation item labeled "CLI" that links to the file cli.md .
|
@vaibhavbhalla2505 can you show me how this looks |
There was a problem hiding this comment.
Pull request overview
This PR adds CLI documentation to the arc-api-docs by introducing a new packages section with CLI command reference material. The documentation provides comprehensive information about the @sourceloop/cli package, including installation instructions and detailed command descriptions.
- Adds CLI documentation page with installation and command reference
- Creates navigation structure for packages section
- Documents 8 CLI commands: autocomplete, cdk, extension, help, mcp, microservice, scaffold, and update
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
| File | Description |
|---|---|
| docs/arc-api-docs/packages/pages.yml | Adds navigation configuration for the packages section with CLI as the first entry |
| docs/arc-api-docs/packages/cli.md | Comprehensive CLI documentation with installation instructions, command usage, options, and examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| OPTIONS | ||
| -a, --applicationClassName | ||
| -d, --dir | ||
| -i, --iac=(lambda) |
There was a problem hiding this comment.
Line 58 has an unnecessary trailing space after "(lambda)" that should be removed for consistency. The other option lines in the documentation (lines 56, 57, 59-61) don't have trailing spaces, so this line should match that pattern.
| -i, --iac=(lambda) | |
| -i, --iac=(lambda) |
| -a, --applicationClassName | ||
| -d, --dir | ||
| -i, --iac=(lambda) | ||
| -o, --overwriteDockerfile |
There was a problem hiding this comment.
Line 59 has an unnecessary trailing space after "--overwriteDockerfile" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
| -o, --overwriteDockerfile | |
| -o, --overwriteDockerfile |
| --cwd | ||
| --description | ||
| --helmPath | ||
| --help |
There was a problem hiding this comment.
Line 136 has an unnecessary trailing space after "--help" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
| --help | |
| --help |
| --description | ||
| --helmPath | ||
| --help | ||
| --integrateWithBackstage |
There was a problem hiding this comment.
Line 137 has an unnecessary trailing space after "--integrateWithBackstage" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
| --integrateWithBackstage | |
| --integrateWithBackstage |
| --help | ||
| --integrateWithBackstage | ||
| --issuePrefix | ||
| --jenkinsfile |
There was a problem hiding this comment.
Line 139 has an unnecessary trailing space after "--jenkinsfile" that should be removed for consistency. The other option lines in the documentation don't have trailing spaces, so this line should match that pattern.
| --jenkinsfile | |
| --jenkinsfile |
| @@ -0,0 +1,152 @@ | |||
| @sourceloop/cli / | |||
|
|
|||
| # @sourceloop-cli | |||
There was a problem hiding this comment.
The heading # @sourceloop-cli is inconsistent with the package name shown elsewhere in the document. The package name is @sourceloop/cli (with a forward slash), as seen in line 1, line 12, and line 96. The heading should be updated to match the actual package name @sourceloop/cli for consistency.
| # @sourceloop-cli | |
| # @sourceloop/cli |
|
|
||
| ## Installation | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
The word "shell" is incorrectly capitalized as "Shell" in the code block header. This should be lowercase "shell" to be consistent with standard Markdown code block syntax.
| - sl autocomplete | ||
| - sl cdk | ||
| - sl extension | ||
| - sl help |
There was a problem hiding this comment.
The trailing space on line 23 should be removed. This appears after "sl help" and before the line break, which is inconsistent with the formatting of other command list items.
| - sl help | |
| - sl help |
Screen.Recording.2025-12-12.at.11.59.51.AM.mov |
No description provided.