revise CLI documentation

[edavidaja]

Intent

Add more comprehensive documentation of the CLI

Type of Change

• Bug Fix
• New Feature
• Breaking Change

Approach

• move the README that currently provides most documentation to docs/
  • The readme is currently disjointed and pretty long; this PR splits it into some thematically consistent chunks
  • replace the existing readme with a stripped down version and links to the new docs
• Use mkdocs-click to generate pages for each rsconnect subcommand.
  • quartodoc does not currently provide support for documenting command-line interfaces.
  • we could render all the commands and subcommands as one page, but that seems less helpful than breaking things up by command
    • subcommand pages are rendered without the rsconnect command; this is a limitation of mkdocs-click

Automated Tests

Added a preview action to deploy the site to github pages

Directions for Reviewers

uv venv
uv pip install -e ".[docs]"
. ./.venv/bin/activate
mkdocs serve

Checklist

• I have updated CHANGELOG.md to cover notable changes.
• I have updated all related GitHub issues to reflect their current state.

[github-actions]

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
5096	3828	75%	0%	🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 3d990d1 by action🐍

[github-actions]

PR Preview Action v1.6.1
Preview removed because the pull request was closed.
2025-05-22 13:24 UTC

[tdstein]

Overall looks great! The CLI documentation is 💯.

Left a few minor comments, but neither are blocking.

[tdstein]

What's the target use case for running on closed? You might be able to remove this.

[edavidaja]

Based on the action docs I think the close event is used to delete the preview--the build is skipped on line 26 if the event is closed.