Skip to content

docs: add serverless to the README - #125

Merged
Ryank90 merged 2 commits into
rc/serverlessfrom
docs/readme-serverless
Sep 23, 2026
Merged

Ryank90 merged 2 commits into
rc/serverlessfrom
docs/readme-serverless

Conversation

@Ryank90

@Ryank90 Ryank90 commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Mention serverless in the README intro and quick start, next to inference.
  • Add a runware serverless command section with deploy, invoke, logs, env, secrets, scale, and lifecycle examples, linking to the generated docs.
  • Include RUNWARE_DASHBOARD_URL and list serverless in the completion demo.

Test plan

  • README intro and quick start mention runware serverless deploy
  • Examples match the current command names (apps invoke, secrets attach, apps env set)
  • Create-only flags and the env/secret rollout note do not tell people to redeploy source to change a variable

The generated command reference already covers the group; the README
still only walked through inference.
@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. To trigger a review, include coderabbit-review in the PR description. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: e21994c7-d4fd-49c9-a714-d18ec60f39d6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md

### `runware serverless` — applications

Deploy, invoke, and manage Runware serverless applications. Full command reference is in [docs/runware_serverless.md](./docs/runware_serverless.md).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought (non-blocking): This block copies about 25 commands from the generated reference, and make docs does not update the README. Keep the main flow (gpus, deploy, invoke, logs) and let the link carry the rest, so that this copy does not go stale.

Comment thread README.md Outdated
Comment thread README.md Outdated
The README implied the entry file's directory is packed. It is the working directory unless --src-dir is set, and apps scale can change the GPU type after create.
@Ryank90
Ryank90 merged commit e427c1e into rc/serverless Sep 23, 2026
4 checks passed
@Ryank90
Ryank90 deleted the docs/readme-serverless branch September 23, 2026 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants