Skip to content

docs: rewrite usage documentation - #144

Merged
hughgrigg merged 1 commit into
mainfrom
codex/docs/rewrite-documentation
Sep 1, 2026
Merged

docs: rewrite usage documentation#144
hughgrigg merged 1 commit into
mainfrom
codex/docs/rewrite-documentation

Conversation

@hughgrigg

Copy link
Copy Markdown
Contributor

Rewrites the README and every topic guide around the current Rainlytics API. It adds a complete getting-started path from CDK installation through the first stored report. It also replaces design-history-heavy explanations with direct setup and usage guidance.

  • Conventional commit message, used as the title
  • Conventional branch name, like feat/concise-description
  • Full check with pnpm run check passed
  • Rebased off latest main
  • User-facing behaviour is documented in docs/

The documentation, formatting, linting, build, package and beacon-size stages pass locally. The Yulin-backed coverage stage loses simulator state on this host, including from a clean worktree under Node 26. CI will rerun it.

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (1)
  • docs:

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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 068f9ba0-23bb-420b-a4c5-283812f5e2f6

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

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

@hughgrigg
hughgrigg merged commit a468f5f into main Sep 1, 2026
8 checks passed
@hughgrigg
hughgrigg deleted the codex/docs/rewrite-documentation branch September 1, 2026 14:57
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.

1 participant