Skip to content

docs: expand with-watch documentation#365

Merged
kdy1 merged 1 commit intomainfrom
kdy1/with-watch-docs
Apr 10, 2026
Merged

docs: expand with-watch documentation#365
kdy1 merged 1 commit intomainfrom
kdy1/with-watch-docs

Conversation

@kdy1
Copy link
Copy Markdown
Contributor

@kdy1 kdy1 commented Apr 10, 2026

Summary

  • expand the internal with-watch contract docs to better document command modes, inference boundaries, rerun behavior, and release/install guarantees
  • turn the crate README into a more complete user guide with quick start, troubleshooting, and shell limitation guidance
  • add a public with-watch Mintlify page and wire it into the public docs navigation and overview pages

Testing

  • cargo run -p with-watch -- --help
  • pnpm --filter public-docs test

@kdy1 kdy1 enabled auto-merge (squash) April 10, 2026 18:55
@kdy1 kdy1 merged commit 7e0cb23 into main Apr 10, 2026
16 checks passed
@kdy1 kdy1 deleted the kdy1/with-watch-docs branch April 10, 2026 18:56
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 374d54fdca

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


## Shell support boundaries

- `--shell` supports command-line expressions with `&&`, `||`, and `|`.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Add Unix-only caveat for --shell usage

This section describes --shell support as if it is generally available, but the CLI explicitly errors on non-Unix systems (WithWatchError::ShellExecutionUnsupportedPlatform in crates/with-watch/src/error.rs). As written, Windows users following the new public quick-start/shell guidance will hit an immediate runtime failure, so this page should explicitly state the Unix-only platform boundary (matching the crate README).

Useful? React with 👍 / 👎.

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