ci: add descriptive workflow tracking configuration summary

[Rish-2006]

Description

This pull request adds an architectural tracking description summary block to the top of the primary GitHub Actions automated integration configuration file.

Related Issue

Closes #1853

Which package(s)?

website

Type of Change

• Documentation ('type:docs')

Summary by CodeRabbit

• Documentation

  • Added a setup note to the development guide with guidance for permission or execution policy errors on Windows, macOS, and Linux.

• Chores

  • Updated the CI workflow with additional descriptive context about the pipeline and when it runs.

[github-actions]

Hi @Rish-2006 👋

⭐ Star this repo before your PR merges.

Why? GSSoC 2026 contributors who star get priority review and points credit. After you star, push any commit (or re-run this check). The needs-star label lifts automatically.

Thanks for your contribution to TermUI.

[coderabbitai]

📝 Walkthrough

Walkthrough

A header comment block is added to .github/workflows/ci.yml describing the pipeline's purpose and triggers. A troubleshooting note is added to README.md advising users to use Administrator or sudo privileges when encountering permission errors during setup.

Changes

Documentation and CI comment additions

Layer / File(s)	Summary
CI workflow comment and README troubleshooting note .github/workflows/ci.yml, README.md	Adds a header comment to the CI workflow describing its purpose and triggers; adds a README note advising elevated privileges for setup errors on Windows and macOS/Linux.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 A comment here, a note right there,
The pipeline now has docs to wear.
Sudo this and admin that,
The rabbit left a welcome mat.
Hop along, new friends — it's clear! 🌿

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The workflow banner adds purpose and triggers, but it does not document the environment matrix setup required by #1853.	Expand the top comment block to describe the CI environment matrix as requested in #1853, not just the pipeline purpose and triggers.
Out of Scope Changes check	⚠️ Warning	The README sudo/admin setup note is unrelated to the workflow-summary issue and appears to be extra scope.	Remove the README change or split it into a separate documentation PR focused on setup permissions.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise, type-prefixed, and accurately summarizes the CI workflow comment summary change.
Description check	✅ Passed	It includes the PR purpose, linked issue, package, and change type, though some template sections are left blank.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 481-482: The setup note in README should not recommend using sudo
for Bun commands, and it should use macOS instead of Mac. Update the guidance in
the README section that mentions execution policy/permission errors to separate
Windows PowerShell execution policy fixes from Unix/macOS permission
troubleshooting, and point users toward fixing directory ownership or Bun’s
official troubleshooting rather than suggesting elevated privileges. Keep the
wording anchored around the existing setup note so it replaces the current
blanket Administrator/sudo advice.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4e315424-6726-47f8-98dd-03731f325b23

📥 Commits

Reviewing files that changed from the base of the PR and between 85e8d36 and ed88574.

📒 Files selected for processing (2)

• .github/workflows/ci.yml
• README.md

[coderabbitai]

🩺 Stability & Availability | 🟠 Major | ⚡ Quick win

Avoid recommending sudo for Bun commands.

Using sudo with Bun (sudo bun install, etc.) typically creates downstream permission issues in ~/.bun, node_modules, and cache directories. The correct fix for EACCES errors is usually fixing directory ownership (chown -R $(whoami) <dir>) rather than elevating privileges. Additionally, "Mac" should be "macOS" for accuracy.

Consider rewording to:

• Separate Windows execution policy (PowerShell) from Unix permission issues.
• Direct users to check directory ownership or Bun's official troubleshooting instead of blanket sudo advice.

 > **Note:** If you encounter execution policy or permission errors during setup, open your terminal as an Administrator (Windows) or use `sudo` before running commands (Mac/Linux).
+> **Note:** On Windows, PowerShell execution policy errors may require Administrator privileges. On macOS/Linux, permission errors with Bun are usually fixed by ensuring correct directory ownership rather than using `sudo`.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	> **Note:** If you encounter execution policy or permission errors during setup, open your terminal as an Administrator (Windows) or use `sudo` before running commands (Mac/Linux).
	> **Note:** On Windows, PowerShell execution policy errors may require Administrator privileges. On macOS/Linux, permission errors with Bun are usually fixed by ensuring correct directory ownership rather than using `sudo`.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 481 - 482, The setup note in README should not
recommend using sudo for Bun commands, and it should use macOS instead of Mac.
Update the guidance in the README section that mentions execution
policy/permission errors to separate Windows PowerShell execution policy fixes
from Unix/macOS permission troubleshooting, and point users toward fixing
directory ownership or Bun’s official troubleshooting rather than suggesting
elevated privileges. Keep the wording anchored around the existing setup note so
it replaces the current blanket Administrator/sudo advice.