Skip to content

GH#14019: tighten rich-results.md (130→103 lines)#14027

Merged
marcusquinn merged 1 commit intomainfrom
chore/GH-14019-tighten-rich-results
Apr 1, 2026
Merged

GH#14019: tighten rich-results.md (130→103 lines)#14027
marcusquinn merged 1 commit intomainfrom
chore/GH-14019-tighten-rich-results

Conversation

@alex-solovyev
Copy link
Copy Markdown
Collaborator

Summary

Tighten .agents/seo/rich-results.md from 130 → 103 lines (21% reduction) with zero information loss.

Removed (27 lines)

  • Manual Testing section (4 lines) — restated the URL already in Quick Reference with self-evident instructions ("open URL, enter URL, click test")
  • Common Rich Result Types table (18 lines) — static subset of Google's gallery that will go stale; the authoritative link is preserved
  • Redundant code comments (3 lines) — // Wait for input field and enter URL, # Test multiple URLs, # Extract JSON-LD from a page — obvious from section headings and code context

Preserved

  • All code blocks (Playwright script, batch testing loop, JSON-LD extraction)
  • All URLs (Rich Results Test, Schema.org Validator, Google gallery)
  • API deprecation notice and CAPTCHA warning
  • YAML frontmatter (tools, mode)
  • Related links section

Relocated

  • Google's structured data gallery link moved from removed table to Quick Reference bullet for better discoverability

Runtime Testing

  • Risk level: Low (docs/agent prompt only)
  • Verification: self-assessed — no runtime behavior change; file is a reference doc

Closes #14019


aidevops.sh v3.5.454 plugin for OpenCode v1.3.7 with claude-opus-4-6 spent 1m and 4,214 tokens on this as a headless worker.

Remove redundant Manual Testing section (restates Quick Reference URL),
Common Rich Result Types table (subset of linked Google gallery), and
obvious code comments. Relocate gallery link to Quick Reference for
better discoverability. Zero information loss.
@alex-solovyev alex-solovyev added the origin:interactive Auto-created from TODO.md tag label Mar 30, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Important

Review skipped

Auto reviews are limited based on label configuration.

🚫 Review skipped — only excluded labels are configured. (1)
  • no-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b57643c5-cc14-4bd5-947a-e17c1449155c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/GH-14019-tighten-rich-results

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

🔍 Code Quality Report

�[0;35m[MONITOR]�[0m Code Review Monitoring Report

SonarCloud: 0 bugs, 0 vulnerabilities, 1 code smells

Mon Mar 30 08:29:07 UTC 2026: Code review monitoring started
Mon Mar 30 08:29:08 UTC 2026: SonarCloud - Bugs: 0, Vulnerabilities: 0, Code Smells: 1

📈 Current Quality Metrics

  • BUGS: 0
  • CODE SMELLS: 1
  • VULNERABILITIES: 0

Generated on: Mon Mar 30 08:29:11 UTC 2026


Generated by AI DevOps Framework Code Review Monitoring

@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request streamlines the SEO rich results documentation by removing redundant comments from code snippets and deleting the 'Manual Testing' and 'Common Rich Result Types' sections. It also adds a direct link to Google's structured data gallery in the tools section for better reference. I have no feedback to provide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

origin:interactive Auto-created from TODO.md tag

Projects

None yet

Development

Successfully merging this pull request may close these issues.

simplification: tighten agent doc Google Rich Results Test (.agents/seo/rich-results.md, 130 lines)

2 participants