docs: fix typo and remove the weird line #2223

DeepaPrasanna · 2024-10-06T07:46:51Z

What does this PR do?

Fix typos and remove the weird line. There was another typo in that page. Fixed that too

Fixes #2210

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?

Check the word explicitly here
Check the word against and there should be not that weird line too here

Checklist

Required

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

Bug Fixes
- Corrected typographical errors for improved clarity in the documentation.
- Removed an unnecessary comment regarding user age to streamline content.

changeset-bot · 2024-10-06T07:46:55Z

⚠️ No Changeset found

Latest commit: 4c16f91

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 · 2024-10-06T07:46:57Z

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

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 6, 2024 7:47am

vercel · 2024-10-06T07:46:58Z

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

A member of the Team first needs to authorize it.

coderabbitai · 2024-10-06T07:46:59Z

📝 Walkthrough

Walkthrough

The pull request involves modifications to the overview.mdx document, primarily aimed at correcting typographical errors and improving the clarity of the text. Specific changes include spelling corrections and the removal of a comment regarding user age, which simplifies the content without altering its functionality.

Changes

File Path	Change Summary
apps/docs/libraries/ts/sdk/overview.mdx	Corrected spelling errors and removed a comment about user age.

Assessment against linked issues

Objective	Addressed	Explanation
Clarify the definition for baseUrl in the docs (#2210)	❌	The comment regarding user age was removed, but no clarification for baseUrl was provided.

Possibly related PRs

docs: Fixes a few typos in the docs from revoke to modify / retrieve #2212: This PR also focuses on correcting typographical errors in documentation, similar to the changes made in the main PR, which involved fixing spelling mistakes in the overview.mdx file.

Suggested labels

Documentation, 🕹️ oss.gg, :joystick: 150 points, hacktoberfest

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 791b789 and 4c16f91.

📒 Files selected for processing (1)

apps/docs/libraries/ts/sdk/overview.mdx (2 hunks)

🧰 Additional context used

🪛 LanguageTool

apps/docs/libraries/ts/sdk/overview.mdx

[formatting] ~48-~48: Consider adding a comma after ‘Fortunately’ for more clarity.
Context: ...explicitly return errors to be handled. Fortunately typescript helps us here and everything...

(CONJUNCTIVE_LINKING_ADVERB_COMMA_PREMIUM)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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 · 2024-10-06T07:47:04Z

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

oss-gg · 2024-10-06T09:05:38Z

Awarding DeepaPrasanna: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/DeepaPrasanna

* wip: Who Am I route * Resolved changes * 2 tests one still remaining * fix(www): add missing langs to analytics bento (#2214) * fix(www): add missing langs to analytics bento Also, add a copy button to the code editor for one-click code copying, removing the need for manual selection. * refactor(www): extract langs SVG icons into separate file Also, rename and move <Editor /> components to components/ui folder. * refactor(www): extract copy code snippet button to separate file * refactor(www): apply coderabbitai review comments * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix: create bucket if it doesn't exist * fix: revalidate cache * docs: fix typo and remove the weird line (#2223) * docs: correct spelling of EXPRED to EXPIRED (#2228) * Added third happy test * chore: add docs, changesets, fix path * Update apps/docs/api-reference/keys/whoami.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Nazar Poshtarenko <32395926+unrenamed@users.noreply.github.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: chronark <dev@chronark.com> Co-authored-by: Anne Deepa Prasanna <anneraj73@gmail.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

docs: fix typo and remove the weird line

4c16f91

DeepaPrasanna requested review from perkinsjr and chronark as code owners October 6, 2024 07:46

github-actions bot added 🕹️ 150 points Documentation Improvements or additions to documentation hacktoberfest 🕹️ oss.gg labels Oct 6, 2024

vercel bot deployed to Preview – engineering October 6, 2024 07:47 View deployment

chronark approved these changes Oct 6, 2024

View reviewed changes

chronark merged commit 85e2436 into unkeyed:main Oct 6, 2024
6 of 10 checks passed

DeepaPrasanna deleted the fix/docs branch October 6, 2024 09:09

coderabbitai bot mentioned this pull request Oct 6, 2024

docs: correct spelling of EXPRED to EXPIRED #2228

Merged

18 tasks

harshsbhat pushed a commit to harshsbhat/unkey that referenced this pull request Oct 6, 2024

docs: fix typo and remove the weird line (unkeyed#2223)

94aa1f5

coderabbitai bot mentioned this pull request Oct 11, 2024

docs: getVerifications instead of get #2329

Merged

18 tasks

coderabbitai bot mentioned this pull request Oct 21, 2024

fix: Typo in introduction.mdx #2519

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix typo and remove the weird line #2223

docs: fix typo and remove the weird line #2223

DeepaPrasanna commented Oct 6, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 6, 2024

vercel bot commented Oct 6, 2024 •

edited

Loading

vercel bot commented Oct 6, 2024

coderabbitai bot commented Oct 6, 2024 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Oct 6, 2024 •

edited

Loading

oss-gg bot commented Oct 6, 2024

docs: fix typo and remove the weird line #2223

docs: fix typo and remove the weird line #2223

Conversation

DeepaPrasanna commented Oct 6, 2024 • edited by coderabbitai bot Loading

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

changeset-bot bot commented Oct 6, 2024

⚠️ No Changeset found

vercel bot commented Oct 6, 2024 • edited Loading

vercel bot commented Oct 6, 2024

coderabbitai bot commented Oct 6, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Oct 6, 2024 • edited Loading

oss-gg bot commented Oct 6, 2024

DeepaPrasanna commented Oct 6, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Oct 6, 2024 •

edited

Loading

coderabbitai bot commented Oct 6, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Oct 6, 2024 •

edited

Loading