Skip to content

fix(docs): remove invalid sidebar slug causing build failure#17

Merged
yacosta738 merged 4 commits into
mainfrom
fix/docs-sidebar-slug
Feb 17, 2026
Merged

fix(docs): remove invalid sidebar slug causing build failure#17
yacosta738 merged 4 commits into
mainfrom
fix/docs-sidebar-slug

Conversation

@yacosta738
Copy link
Copy Markdown
Contributor

@yacosta738 yacosta738 commented Feb 17, 2026

This pull request introduces updates to repository protection rules and modifies the documentation site configuration. The main changes are grouped into repository protection improvements and documentation navigation updates.

Repository protection improvements:

Documentation navigation updates:

Summary by CodeRabbit

  • Documentation

    • Removed C4 Diagrams link from the docs sidebar.
    • Added an "Agent Coding Guide" documenting agent workflows, guardrails, and validation.
    • Added a comprehensive Gradle/Kotlin project guidance document covering conventions and build/test practices.
  • Chores

    • Enforced an additional required status check under branch protection and enabled strict status-check policy.

@github-actions
Copy link
Copy Markdown
Contributor

Thank you for contributing to this project with this PR, welcome to the community and the amazing world of open source!

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 17, 2026

Warning

Rate limit exceeded

@yacosta738 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 18 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Updates include stricter GitHub minor-branch protection status checks, removal of a C4 Diagrams sidebar entry in the docs config, and addition of two documentation files: a Copilot/Gradle/Kotlin guide backup and an Agent coding guide.

Changes

Cohort / File(s) Summary
GitHub Rulesets
.github/rulesets/minor-protection.json
Replaced empty required status checks with a single core-check entry (integration_id: 15368) and enabled strict_required_status_checks_policy.
Docs config
clients/web/apps/docs/astro.config.mjs
Removed the "C4 Diagrams" sidebar entry under Architecture from the Astro site configuration.
Copilot / Gradle guide (new file)
.github/copilot-instructions.md.bak.1771330226
Added a new backup documentation file containing Gradle/Kotlin project guidelines, commands, coding conventions, patterns, and examples.
Agent guide (new file)
clients/agent-runtime/AGENTS.md
Added a new "Agent Coding Guide" documenting repository conventions, agent workflow, constraints, validation, and PR/commit practices.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description addresses the main changes (repository protection and documentation navigation updates) but lacks critical sections required by the template: Summary, Tested Information, and complete Breaking Changes/Checklist sections are missing or incomplete. Add the missing Summary and Tested Information sections to fully document the purpose, testing approach, and validation of these changes. Complete all template sections including the checklist.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix(docs): remove invalid sidebar slug causing build failure' clearly addresses the primary change documented in the PR—removing the C4 Diagrams sidebar item that was causing a build issue. It directly matches the main objective stated in the PR description.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/docs-sidebar-slug

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 17, 2026

✅ Contributor Report

User: @yacosta738
Status: Passed (12/13 metrics passed)

Metric Description Value Threshold Status
PR Merge Rate PRs merged vs closed 89% >= 30%
Repo Quality Repos with ≥100 stars 0 >= 0
Positive Reactions Positive reactions received 9 >= 1
Negative Reactions Negative reactions received 0 <= 5
Account Age GitHub account age 3034 days >= 30 days
Activity Consistency Regular activity over time 108% >= 0%
Issue Engagement Issues with community engagement 0 >= 0
Code Reviews Code reviews given to others 361 >= 0
Merger Diversity Unique maintainers who merged PRs 3 >= 0
Repo History Merge Rate Merge rate in this repo 92% >= 0%
Repo History Min PRs Previous PRs in this repo 14 >= 0
Profile Completeness Profile richness (bio, followers) 90 >= 0
Suspicious Patterns Spam-like activity detection 1 N/A

Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-02-17 to 2026-02-17

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Nitpick comments (1)
clients/agent-runtime/AGENTS.md (1)

1-4: Missing version and compatibility information.

The document lacks version or compatibility metadata (e.g., minimum Rust edition, MSRV, supported platforms). Based on learnings, AGENTS.md files should include version information and compatibility details for agents.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@clients/agent-runtime/AGENTS.md` around lines 1 - 4, Add explicit version and
compatibility metadata to AGENTS.md by inserting a "Version & Compatibility"
section under the existing title ("AGENTS.md — Agent Coding Guide") that states
the current document version, minimum Rust edition and MSRV, supported
platforms/architectures, and any compatibility guarantees (e.g., breaking change
policy); update the Scope line if needed to reference the version, and ensure
this section also points to the repository CHANGELOG/RELEASE notes and CI matrix
that must be updated when compatibility changes.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/copilot-instructions.md.bak.1771330226:
- Around line 8-18: The blockquote for the "Core Principles" callout is broken
because the subsequent lines (the security list and indented items) lost their
leading '>' markers; fix by restoring the '>' blockquote prefix to the lines
following the initial "**⚠️ CRITICAL: Security First, Performance Second**" so
the entire callout (including "Security First" paragraph and the indented list
items like "Never trust user input", "Use parameterized queries...", "Validate
and sanitize all data", etc.) remain inside the same blockquote and render
correctly.
- Around line 1-194: Two backup files (copilot-instructions.md.bak.1771330226
and copilot-instructions.md.bak.1771329303) were committed; either rename each
to remove the .bak suffix (e.g., copilot-instructions.md) restoring the intended
file name, or delete the backup copies if they are unintended, then commit the
change so only the proper file remains (the existing *.bak rule in .gitignore
will prevent future backups from being committed).

In `@clients/agent-runtime/AGENTS.md`:
- Around line 3-4: Update the scope declaration in AGENTS.md so it accurately
reflects the file's coverage: either move the file to the repository root or a
top-level .agents/ directory if the protocol truly applies to the whole repo, or
change the line "Scope: entire repository" to a precise module scope such as
"Scope: clients/agent-runtime (Rust agent-runtime module)" to match the
Rust-centric content; ensure the updated statement is the only change to the
header so references to the protocol remain correct.

---

Nitpick comments:
In `@clients/agent-runtime/AGENTS.md`:
- Around line 1-4: Add explicit version and compatibility metadata to AGENTS.md
by inserting a "Version & Compatibility" section under the existing title
("AGENTS.md — Agent Coding Guide") that states the current document version,
minimum Rust edition and MSRV, supported platforms/architectures, and any
compatibility guarantees (e.g., breaking change policy); update the Scope line
if needed to reference the version, and ensure this section also points to the
repository CHANGELOG/RELEASE notes and CI matrix that must be updated when
compatibility changes.

Comment thread .github/copilot-instructions.md.bak.1771330226 Outdated
Comment thread .github/copilot-instructions.md.bak.1771330226 Outdated
Comment thread clients/agent-runtime/AGENTS.md Outdated
@yacosta738 yacosta738 merged commit 9b76bcc into main Feb 17, 2026
11 checks passed
@yacosta738 yacosta738 deleted the fix/docs-sidebar-slug branch February 17, 2026 12:30
@yacosta738 yacosta738 mentioned this pull request Mar 16, 2026
@coderabbitai coderabbitai Bot mentioned this pull request May 4, 2026
8 tasks
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