Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #60

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Update README.md #60

merged 1 commit into from
Jun 25, 2024

Conversation

eriktaubeneck
Copy link
Member

@eriktaubeneck eriktaubeneck commented Jun 24, 2024

add note about restarting browser after installing local certs.

Summary by CodeRabbit

  • Documentation
    • Updated instructions for setting up a certificate using mkcert to include a clarification about ensuring proper installation, potentially requiring a browser restart.

add note about restarting browser after installing local certs.
@eriktaubeneck eriktaubeneck requested a review from akoshelev June 24, 2024 20:07
Copy link

vercel bot commented Jun 24, 2024

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

Name Status Preview Comments Updated (UTC)
draft ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 24, 2024 8:08pm

Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Walkthrough

The change introduces an important clarification to the README.md file, detailing the need for users to verify the successful installation of certificates using mkcert. This update advises users that a browser restart might be necessary to fully apply the certificate changes.

Changes

File Change Summary
README.md Added clarification to the mkcert setup instructions, mentioning the need to ensure the certificate is properly installed and potentially requiring a browser restart.

Poem

In our README, a note so clear,
To guide your certs with friendly cheer.
Install them well, let browsers know,
Restart if needed, for the flow.
With mkcert, secure and bright,
Your setup shines, day and night. 🌟
Cheers to changes, just so right! 🐰✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fb521c3 and 0b49a5f.

Files selected for processing (1)
  • README.md (1 hunks)
Additional context used
Markdownlint
README.md

9-9: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


43-43: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


51-51: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


67-67: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


76-76: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


95-95: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


96-96: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


105-105: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


110-110: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


118-118: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


220-220: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


221-221: Expected: 1; Actual: 3 (MD012, no-multiple-blanks)
Multiple consecutive blank lines


1-1: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


222-222: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines


10-10: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


222-222: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document


21-21: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


26-26: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


84-84: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


89-89: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


145-145: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


173-173: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines


20-20: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


27-27: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


47-47: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


53-53: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


100-100: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


204-204: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines


205-205: null (MD034, no-bare-urls)
Bare URL used


206-206: null (MD034, no-bare-urls)
Bare URL used


16-16: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


119-119: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


158-158: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading


21-21: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


70-70: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


84-84: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


89-89: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


123-123: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


135-135: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


142-142: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


148-148: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


154-154: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


162-162: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


168-168: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


173-173: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


179-179: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


193-193: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified


214-214: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified

Additional comments not posted (1)
README.md (1)

172-172: Note on Browser Restart After Certificate Installation

The added note about needing to restart the browser after installing local certificates is a crucial piece of information for users to ensure the system works as expected post-installation. This update improves the clarity and usability of the documentation.

@akoshelev akoshelev merged commit 6b7e839 into main Jun 25, 2024
3 checks passed
@eriktaubeneck eriktaubeneck deleted the eriktaubeneck-patch-1 branch June 26, 2024 20:37
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.

2 participants