Skip to content

docs: Fix incorrect URL for "Read our blog post" in Zen Readme#3002

Merged
chronark merged 1 commit intounkeyed:mainfrom
kumachan99:fix-zen-readme
Mar 20, 2025
Merged

docs: Fix incorrect URL for "Read our blog post" in Zen Readme#3002
chronark merged 1 commit intounkeyed:mainfrom
kumachan99:fix-zen-readme

Conversation

@kumachan99
Copy link
Contributor

@kumachan99 kumachan99 commented Mar 20, 2025

What does this PR do?

Fixes an incorrect URL in the README for the “Read our blog post” link.

Fixes #3001

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

No testing required. This is a documentation-only change (updating a URL).

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • Documentation
    • Revised the blog post link in the documentation to point to the official online resource. This update ensures that users accessing the documentation are directed to the current and accurate online blog post, providing a more reliable gateway for additional information.

Fix Invalid URL of "Read our blog post"
@changeset-bot
Copy link

changeset-bot bot commented Mar 20, 2025

⚠️ No Changeset found

Latest commit: 587f43c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Mar 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 20, 2025 11:55am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 20, 2025 11:55am
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 20, 2025 11:55am
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 20, 2025 11:55am

@CLAassistant
Copy link

CLAassistant commented Mar 20, 2025

CLA assistant check
All committers have signed the CLA.

@vercel
Copy link

vercel bot commented Mar 20, 2025

@kumachan99 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2025

📝 Walkthrough

Walkthrough

The pull request updates the README file for the Zen HTTP library by modifying a hyperlink. The URL reference has been changed from http://localhost:3000/blog/zen to http://www.unkey.com/blog/zen. No changes were made to any exported or public entities.

Changes

File Change Summary
go/pkg/zen/README.md Updated hyperlink from http://localhost:3000/blog/zen to http://www.unkey.com/blog/zen

Assessment against linked issues

Objective Addressed Explanation
Update README URL in Zen (#3001) New URL uses HTTP instead of the required HTTPS protocol.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dde1039 and 587f43c.

📒 Files selected for processing (1)
  • go/pkg/zen/README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Test Packages / Test ./internal/clickhouse
  • GitHub Check: Test Go API Local / Test
  • GitHub Check: Test API / API Test Local
  • GitHub Check: Test Agent Local / test_agent_local
  • GitHub Check: Build / Build
🔇 Additional comments (1)
go/pkg/zen/README.md (1)

4-4: Updated Blog Post URL

The hyperlink has been updated from the incorrect localhost address to http://www.unkey.com/blog/zen. This change aligns perfectly with the PR objective to correct the URL. Please verify that the target page is accessible and consider using HTTPS if the target supports it for improved security.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added Documentation Improvements or additions to documentation Needs Approval Needs approval from Unkey labels Mar 20, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Mar 20, 2025

Thank you for following the naming conventions for pull request titles! 🙏

@kumachan99 kumachan99 changed the title doc: Fix incorrect URL for "Read our blog post" in Zen Readme docs: Fix incorrect URL for "Read our blog post" in Zen Readme Mar 20, 2025
@chronark
Copy link
Collaborator

Oh thank you
would you mind signing the CLA, then I can merge it

@kumachan99
Copy link
Contributor Author

@chronark
Just signed the CLA! Thanks for the quick review and support. Really appreciate it! 🚀

@chronark
Copy link
Collaborator

tysm

@chronark chronark merged commit a62550f into unkeyed:main Mar 20, 2025
28 of 30 checks passed
revogabe pushed a commit to revogabe/unkey that referenced this pull request Mar 21, 2025
Fix Invalid URL of "Read our blog post"
chronark added a commit that referenced this pull request Apr 8, 2025
* feat: add usage-insight on the desktop-sidebar

* remove console.log

* refactor: improve code consistency and formatting across multiple files

* fix: keep only the progress circle, remove the particle effect, keep the card always open

* refactor: simplify layout and desktop sidebar components, remove unused billing logic

* feat(billing): add usage fetching hook and TRPC query for billing usage data

* fix: update workspace creation logic to set plan to 'free' and improve error handling

* fix: remove unnecessary console log for usage query fetching

* refactor: adjust padding and height in usage insights component for improved layout

* fix: update plan type in usage insights to handle workspace tier and default to 'Free'

* [autofix.ci] apply automated fixes

* refactor: improve code readability and formatting in usage insights component

* refactor: remove Particles component and relocate useMousePosition hook

* refactor: enhance code formatting and readability in desktop sidebar component

* fix: remove use-mouse hook

* pnpm fmt

* pnpm-lock fix

* refactor: update usage insights to use 'tier' instead of 'plan' and simplify loading state handling

* fix: remove outdated and wrong quota check (#3000)

we now have proper quotas, so this check is redundand.

If a workspace is disabled, there is already a warning in the root
layout to contact us.

* Update README.md (#3002)

Fix Invalid URL of "Read our blog post"

* feat: sidebar (#3003)

* feat: add new sidebar

* fix: icon

* fix: padding issues

* feat: add new sidebar

* fix: ui issues

* chore: clenaup

* chore: remove unused button

* fix: collapse issue

* fix: ui issues

* chore: remove unused files

* fix: layout shifts and missing props (#3006)

* fix: layout shift

* fix: missing active tags

* refactor: clean up imports and improve layout component structure

* pnpm fmt

* refactor: simplify usage query options in useFetchUsage hook

* pnpm fmt

* fix: broken lock

* fix: quotas rename to quota

This fixes the incorrect usage max issue

* fix: refetch usage

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Oğuzhan Olguncu <21091016+ogzhanolguncu@users.noreply.github.com>
Co-authored-by: James P <jamesperkins@hey.com>
Co-authored-by: Andreas Thomas <dev@chronark.com>
Co-authored-by: okuma <49895482+kumachan99@users.noreply.github.com>
Co-authored-by: ogzhanolguncu <ogzhan11@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Needs Approval Needs approval from Unkey

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Update README URL in Zen

3 participants