Skip to content

Conversation

@hyperlint-ai
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot commented Jan 27, 2025

Meta Description Fix Proposal(s)

The goal of this pull request is to improve the meta description for pages in the documentation.

Proposing changes to the following files:


🪄 Experimental Hyperlint Feature - Read more 👇

This pull request is part of a series of Hyperlint automations to ease the burden of maintaining documentation.

We'll be introducing this automation, and others, over the coming months. These automations will always open pull requests(or issues) prior to making changes.

If this is not the change you want, please close this pull request.

⚠️ Important Note:
This feature may introduce erroneous changes (although we work really hard to make sure that doesn't happen). Please review the changes before merging.

❌ Limitations:
At this time, our bot can't respond to pull requests or issues.

📩 Need Help?
Please reach out to support with any requests, questions, or concerns.

@hyperlint-ai hyperlint-ai bot requested review from a team and RebeccaTamachiro as code owners January 27, 2025 23:58
@@ -1,6 +1,7 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding/updating meta description for page: http://localhost:1111/dns/

@@ -1,6 +1,7 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding/updating meta description for page: http://localhost:1111/dns/dns-firewall/

@github-actions github-actions bot added product:dns Issues or PRs related to DNS size/s labels Jan 27, 2025
@@ -1,6 +1,7 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding/updating meta description for page: http://localhost:1111/dns/zone-setups/

@bllchmbrs
Copy link
Contributor

@kodster28 , here's the first pass. Let me know of any QA issues you see and we'll keep marching forward!

@kodster28
Copy link
Collaborator

Howdy @bllchmbrs, let me poke into the build failures (maybe it's just spacing / indentation)... but let me tag in @RebeccaTamachiro to evaluate the review burden + accuracy here.

@kodster28
Copy link
Collaborator

kodster28 commented Jan 30, 2025

Okay, @bllchmbrs already some initial feedback from a convo with @RebeccaTamachiro.

  • Size/context scoping: Would there be a way to try and group PRs at a specific, subfolder level? There's still a lot of context switching / breadth within a top-level folder, so this would keep your review context in a tighter, easier space. So, ideally something like a specific PR for everything under https://developers.cloudflare.com/dns/zone-setups/ (up to the limit).
  • Comparison to existing description: In our setup, we have some specific logic -- we're ❄️ 's! -- to grab the first 150 characters and add it as a default meta description. Would there be any way to evaluate the rendered content and only suggest specific head description values for pages that need something more specific?

@kodster28
Copy link
Collaborator

Also, cc: @crwaters16, just in case you wanted to see what's happening here.

@kodster28
Copy link
Collaborator

@bllchmbrs, another comment from @RebeccaTamachiro... can we tone down the "marketing speak" from being so positive?

It's talking about stuff being "easy" or "ideal for Business / Enterprise plans".... I'd really just want more of a factual description and not oozing with as much positivity.

@hyperlint-ai
Copy link
Contributor Author

hyperlint-ai bot commented Jan 31, 2025

Hyperlint automation, closing this pull request as stale.

@hyperlint-ai hyperlint-ai bot closed this Jan 31, 2025
@bllchmbrs
Copy link
Contributor

@kodster28 , will do these updates and follow up. Feedback received!

@kodster28 kodster28 deleted the hyperlint/scan/meta-description/cd9558e branch January 31, 2025 17:16
@bllchmbrs
Copy link
Contributor

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

Labels

product:dns Issues or PRs related to DNS size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants