Skip to content

docs: improve the docs more - #308

Merged
miyoungc merged 2 commits into
mainfrom
miyoungc/doc-improve
Mar 14, 2026
Merged

docs: improve the docs more#308
miyoungc merged 2 commits into
mainfrom
miyoungc/doc-improve

Conversation

@miyoungc

@miyoungc miyoungc commented Mar 14, 2026

Copy link
Copy Markdown
Collaborator

Summary

Add notes about --help to check the cli reference + minor doc fixes.

Testing

  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

@miyoungc
miyoungc marked this pull request as draft March 14, 2026 22:04
@github-actions

github-actions Bot commented Mar 14, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-14 23:35 UTC

@miyoungc
miyoungc requested a review from kirit93 March 14, 2026 22:11
@miyoungc
miyoungc marked this pull request as ready for review March 14, 2026 22:11
@miyoungc miyoungc added the area:docs Documentation and examples label Mar 14, 2026
@miyoungc miyoungc self-assigned this Mar 14, 2026
@miyoungc
miyoungc merged commit a590549 into main Mar 14, 2026
13 checks passed
@miyoungc
miyoungc deleted the miyoungc/doc-improve branch March 14, 2026 23:34
drew pushed a commit that referenced this pull request Mar 16, 2026
* improve docs

* save
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Documentation and examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants