Skip to content

Commit 2a8b28a

Browse files
ross-rldines-rl
andauthored
Ross/br (#96)
## Description <!-- Provide a brief description of your changes --> **Note:** PR titles should follow [Conventional Commits](https://www.conventionalcommits.org/) format (e.g., `feat(devbox): add support for custom env vars` or `fix(snapshot): resolve pagination issue`) as they are used for automatic release notes generation. ## Type of Change <!-- Mark the relevant option with an 'x' --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update - [ ] Code refactoring - [ ] Performance improvement - [ ] Test updates ## Related Issues <!-- Link to related issues using #issue-number --> Closes # ## Changes Made <!-- Describe the changes in detail --> ## Testing <!-- Describe how you tested your changes --> - [ ] I have tested locally - [ ] I have added/updated tests - [ ] All existing tests pass ## Checklist - [ ] My code follows the code style of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have updated the documentation accordingly - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published ## Screenshots (if applicable) <!-- Add screenshots to help explain your changes --> ## Additional Notes <!-- Any additional information that reviewers should know --> --------- Co-authored-by: Alexander Dines <alex@runloop.ai>
1 parent a9ed596 commit 2a8b28a

8 files changed

Lines changed: 715 additions & 101 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
A **TUI + CLI** for the [Runloop.ai](https://runloop.ai) platform. Use it as an **interactive TUI** (Terminal User Interface) with rich UI components, or as a **traditional CLI** for scripting and automation.
88

9-
📖 **[Full Documentation](https://docs.runloop.ai/docs/tools/cli)**
9+
📖 **[Full Documentation](https://docs.runloop.ai/docs/tools/rl-cli)**
1010

1111
<p align="center">
1212
<img src="https://raw.githubusercontent.com/runloopai/rl-cli/main/misc/demo.gif" alt="Runloop CLI Demo" width="800">

scripts/generate-command-docs.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const rootDir = join(__dirname, "..");
1111
const readmePath = join(rootDir, "README.md");
1212

1313
// Default docs path - can be overridden via DOCS_PATH env var or --docs-path argument
14-
const defaultDocsPath = join(rootDir, "..", "docs", "docs", "tools", "cli.mdx");
14+
const defaultDocsPath = join(rootDir, "..", "docs", "docs", "tools", "rl-cli.mdx");
1515

1616
/**
1717
* Generates markdown documentation for the command structure from Commander
@@ -120,7 +120,7 @@ function generateCommandStructure(program) {
120120
}
121121

122122
/**
123-
* Generates a detailed command reference for external docs (cli.mdx)
123+
* Generates a detailed command reference for external docs (rl-cli.mdx)
124124
* Uses Mintlify components for better presentation
125125
*/
126126
function generateDetailedCommandDocs(program) {
@@ -286,7 +286,7 @@ function updateReadme(newCommandStructure) {
286286
}
287287

288288
/**
289-
* Generates the full cli.mdx content
289+
* Generates the full rl-cli.mdx content
290290
*/
291291
function generateCliMdx(program) {
292292
const commandDocs = generateDetailedCommandDocs(program);
@@ -508,7 +508,7 @@ The Runloop CLI is open-source. We welcome contributions!
508508
}
509509

510510
/**
511-
* Updates the external docs cli.mdx file
511+
* Updates the external docs rl-cli.mdx file
512512
*/
513513
function updateDocsMdx(program, docsPath) {
514514
if (!existsSync(docsPath)) {
@@ -547,9 +547,9 @@ function parseArgs() {
547547
Usage: generate-command-docs.js [options]
548548
549549
Options:
550-
--docs-path <path> Path to cli.mdx file (default: ../docs/docs/tools/cli.mdx)
550+
--docs-path <path> Path to rl-cli.mdx file (default: ../docs/docs/tools/rl-cli.mdx)
551551
--skip-readme Skip updating README.md
552-
--skip-docs Skip updating cli.mdx
552+
--skip-docs Skip updating rl-cli.mdx
553553
--help, -h Show this help message
554554
555555
Environment Variables:

0 commit comments

Comments
 (0)