Skip to content

docs: fix typos in proposals (#30976) - #30978

Merged
agaudreault merged 1 commit into
argoproj:masterfrom
zshuying-field-ai:docs/fix-proposal-typos
Nov 12, 2026
Merged

agaudreault merged 1 commit into
argoproj:masterfrom
zshuying-field-ai:docs/fix-proposal-typos

Conversation

@zshuying-field-ai

@zshuying-field-ai zshuying-field-ai commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #30976

Fixes two spelling mistakes in design proposals under docs/proposals/:

  • attach-debug-containers.md: "againts" → "against"
  • multiple-sources-for-applications.md: "Depracating" → "Deprecating"

Documentation only; no code or generated files change.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Title of the PR
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them. (Not applicable: documentation only.)
  • Does this PR require documentation updates? (This PR is the documentation update.)
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged. (Not applicable: spelling fixes in documentation.)
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines. (Not applicable: no feature.)
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Prepared with help from Claude Code; I reviewed both changes.

Summary by CodeRabbit

  • Documentation
    • Corrected spelling errors in two proposal documents.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Shuying Zhu <shuying.zhu@fieldai.com>
@zshuying-field-ai
zshuying-field-ai requested review from a team as code owners November 12, 2026 20:51
@bunnyshell

bunnyshell Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The changes correct spelling errors in two design proposals. The wording around each correction remains otherwise unchanged.

Changes: Proposal typo corrections

Layer / File(s) Summary
Correct proposal text
docs/proposals/attach-debug-containers.md, docs/proposals/multiple-sources-for-applications.md
Corrects “againts” to “against” and “Depracating” to “Deprecating.”

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other · Severity of issue fixed: Low

Suggested reviewers: kyriosgn0, ishitasequeira

Merge Risk: Minimal · up to 32401

This documentation-only change fixes two typos in design proposals and has no runtime impact. It is safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "docs: fix typos in proposals (#30976)" matches the changeset. The PR corrects two spelling errors in design proposals under docs/proposals/: "againts" to "against" and "Depracating" to "Dep…
Description check Passed The description covers the required template items for a documentation-only fix. It links the issue with "Fixes #30976", lists both corrected spellings and their files, and explains why the change is …
Linked Issues check Passed Issue #30976 is the only directly linked issue. It requires two spelling fixes in docs/proposals/. The whole-PR diff (merge base e263590 to head 3240102) shows both fixes: line 90 of attach-debug-cont…
Out of Scope Changes check Passed The whole-PR diff changes exactly two lines in two files, both in docs/proposals/. Each change corrects a misspelling named in #30976. No code, generated files, or unrelated text change. Both hunks ar…
Full details: Title check

Explanation

The title "docs: fix typos in proposals (#30976)" matches the changeset. The PR corrects two spelling errors in design proposals under docs/proposals/: "againts" to "against" and "Depracating" to "Deprecating". The title names the type of change, the area, and the issue number. It does not name the specific words fixed, but that detail is not required.

Full details: Description check

Explanation

The description covers the required template items for a documentation-only fix. It links the issue with "Fixes #30976", lists both corrected spellings and their files, and explains why the change is needed. The checklist is complete, with the inapplicable items marked with reasons. The checklist boxes for the release-note and title conventions are checked, and the DCO sign-off is confirmed. Two template items remain unchecked, but the author explains they do not apply. The description therefore meets the template.

Full details: Linked Issues check

Explanation

Issue #30976 is the only directly linked issue. It requires two spelling fixes in docs/proposals/. The whole-PR diff (merge base e263590 to head 3240102) shows both fixes: line 90 of attach-debug-containers.md changes "againts" to "against", and line 198 of multiple-sources-for-applications.md changes "Depracating" to "Deprecating". No other text changes. The issue has no coding requirements beyond these edits. Its expected outcome, that both words are spelled correctly, is met. Automated tests do not apply to this documentation-only change.

Full details: Out of Scope Changes check

Explanation

The whole-PR diff changes exactly two lines in two files, both in docs/proposals/. Each change corrects a misspelling named in #30976. No code, generated files, or unrelated text change. Both hunks are within scope.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 9f6da6e9-be4f-4a1e-b184-a4aa8a00724a
Commits

Reviewing files that changed from the base of the PR and between e263590 and 3240102.

Files selected for processing: 2

  • docs/proposals/attach-debug-containers.md
  • docs/proposals/multiple-sources-for-applications.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

@agaudreault
agaudreault enabled auto-merge (squash) November 12, 2026 20:53
@agaudreault
agaudreault merged commit 0abe302 into argoproj:master Nov 12, 2026
27 checks passed
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.

docs: typos in two design proposals

2 participants