Skip to content

docs: prioritize Linux, de-emphasize macOS/Windows#221

Draft
matt-dz wants to merge 4 commits into
mainfrom
matt-dz/trusting-tu-284656
Draft

docs: prioritize Linux, de-emphasize macOS/Windows#221
matt-dz wants to merge 4 commits into
mainfrom
matt-dz/trusting-tu-284656

Conversation

@matt-dz
Copy link
Copy Markdown
Collaborator

@matt-dz matt-dz commented May 4, 2026

What does this PR do?

Updates AGENTS.md and docs/RULES.md to make Linux the primary target and explicitly de-prioritise macOS/Windows compatibility guidance.

  • AGENTS.md Platform Support: rewritten to state Linux is the primary target; macOS/Windows are not prioritised for now and compatibility on those platforms is best-effort.
  • AGENTS.md Testing: trimmed Windows-specific assertion-field guidance — the framework fields still exist but should not be added proactively.
  • docs/RULES.md Cross-Platform Compatibility: added a one-line note at the top stating Linux is the primary target and reviewers should not block PRs on hypothetical macOS/Windows breakage. The existing guidance below is preserved as good practice.

Motivation

rshell primarily targets Linux, and macOS/Windows are not prioritised at the moment. Reviewers have been routinely flagging "this may not work on macOS/Windows" in PRs, which generates noise and blocks work that is correct for the actual target. Setting an explicit priority note in the agent docs gives reviewers a clear basis to stop blocking on hypothetical cross-platform breakage.

Testing

Documentation-only change; no code or tests touched.

Checklist

  • Tests added/updated
  • Documentation updated (if applicable)

matt-dz and others added 2 commits May 4, 2026 16:03
v0 primarily targets Linux. Update AGENTS.md Platform Support and
docs/RULES.md to make this explicit so reviewers stop blocking PRs on
hypothetical macOS or Windows breakage. Replace the Cross-Platform
Compatibility block (with its Windows/macOS/Unix subsections) with a
concise Linux-first Platform Targeting section, and trim related
references and Windows-specific test-field guidance.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Reword the platform targeting language to avoid referring to a "v0"
milestone, since the policy is simply that Linux is primary and other
platforms are not prioritised at the moment.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@matt-dz matt-dz changed the title docs: prioritize Linux for v0, de-emphasize macOS/Windows docs: prioritize Linux, de-emphasize macOS/Windows May 4, 2026
matt-dz and others added 2 commits May 4, 2026 16:07
The previous commit removed too much useful cross-platform guidance.
Restore the original Cross-Platform Compatibility section and Sources
links, and add only a one-line note at the top stating Linux is the
primary target and macOS/Windows are not prioritised for now.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Revert the prior trimming of this bullet — the framework feature is
real and the original documentation is the right place for it.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Member

@AlexandreYang AlexandreYang left a comment

Choose a reason for hiding this comment

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

Hum, I think we should keep cross-platform parity as much as possible.

I think we shouldn't phrase it as one platform is more primary or important than others (as much as possible).

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.

2 participants