Skip to content

docs: comprehensive documentation update for v0.3.1#17

Merged
pszymkowiak merged 1 commit intortk-ai:masterfrom
FlorianBruniaux:docs/comprehensive-update
Jan 30, 2026
Merged

docs: comprehensive documentation update for v0.3.1#17
pszymkowiak merged 1 commit intortk-ai:masterfrom
FlorianBruniaux:docs/comprehensive-update

Conversation

@FlorianBruniaux
Copy link
Collaborator

Summary

Comprehensive documentation update to reflect all features added in recent PRs (v0.3.1).

Changes

Version Updates

  • ✅ Update DEB/RPM installation commands to v0.3.1

New Sections

  • ✅ Add Global Flags section (-u/--ultra-compact, -v/--verbose)
  • ✅ Add JavaScript/TypeScript Stack section with 10 commands

New Commands Documented

Files

  • rtk smart - 2-line heuristic code summary

Commands

  • rtk gh pr list/view/... - GitHub CLI integration
  • rtk wget - Downloads with stripped progress bars
  • rtk config - Show/create configuration

Data

  • rtk gain --quota - Monthly quota savings estimate
  • rtk gain --tier <tier> - Quota for specific Claude tier (pro/5x/20x)

Containers

  • rtk kubectl services - Compact service list

JavaScript/TypeScript Stack (new section)

  • rtk lint - ESLint/Biome with grouped violations
  • rtk tsc - TypeScript compiler grouped errors
  • rtk next - Next.js build compact output
  • rtk prettier - Format checker
  • rtk vitest - Test runner (failures only)
  • rtk playwright - E2E tests (failures only)
  • rtk prisma - Prisma CLI (no ASCII art)

Features Coverage

This documentation update covers functionality from:

All commands documented are available in v0.3.1.

Testing

  • ✅ All markdown code blocks properly closed
  • ✅ All documented commands verified with --help
  • ✅ Version numbers updated consistently

This PR focuses solely on documentation - no code changes. All features are already merged and available in v0.3.1.

Copilot AI review requested due to automatic review settings January 30, 2026 08:40
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the README documentation for v0.3.1 to cover all currently implemented features and ensure install instructions reference the new release artifacts. It adds sections for global flags, GitHub CLI integration, quota analysis, Kubernetes services, and a modern JavaScript/TypeScript tooling stack.

Changes:

  • Bump Debian and Fedora/RHEL binary download commands from v0.2.1 to v0.3.1.
  • Add a Global Flags section documenting -u/--ultra-compact and -v/--verbose.
  • Extend the commands overview with new entries for rtk smart, rtk gh …, rtk wget, rtk config, rtk gain --quota/--tier, rtk kubectl services, and a dedicated JavaScript / TypeScript Stack section (lint, tsc, next, prettier, vitest, playwright, prisma).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Updates documentation to reflect all features added in recent PRs:

**Version Updates**
- Update installation commands to v0.3.1 (DEB/RPM packages)

**New Sections**
- Add Global Flags section (-u/--ultra-compact, -v/--verbose)
- Add JavaScript/TypeScript Stack section (10 new commands)

**New Commands Documented**
- Files: `rtk smart` (heuristic code summary)
- Commands: `rtk gh` (GitHub CLI), `rtk wget`, `rtk config`
- Data: `rtk gain --quota` and `--tier` flags
- Containers: `rtk kubectl services`
- JS/TS Stack: lint, tsc, next, prettier, vitest, playwright, prisma

**Features Coverage**
This update documents functionality from:
- PR rtk-ai#5: Git argument parsing improvements
- PR rtk-ai#6: pnpm support
- PR rtk-ai#9: Modern JavaScript/TypeScript stack support
- PR rtk-ai#10: GitHub CLI integration
- PR rtk-ai#11: Quota analysis features
- PR rtk-ai#14: Additional command improvements

All commands documented are available in v0.3.1.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@FlorianBruniaux FlorianBruniaux force-pushed the docs/comprehensive-update branch from 23b9277 to 14f3172 Compare January 30, 2026 08:58
@pszymkowiak pszymkowiak merged commit e0565da into rtk-ai:master Jan 30, 2026
1 check passed
ahundt pushed a commit to ahundt/rtk that referenced this pull request Feb 23, 2026
…update

docs: comprehensive documentation update for v0.3.1
navidemad added a commit to navidemad/rtk that referenced this pull request Mar 1, 2026
- Change fallback_tail message from "could not parse output" to
  "output format not recognized" (less alarming) (issue rtk-ai#16)
- Raise bundle list token savings threshold from ≥5% to ≥10% (issue rtk-ai#17)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

3 participants