Skip to content

docs: Add FAQ section for common questions#261

Open
meichuanyi wants to merge 1 commit into
kernel:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: Add FAQ section for common questions#261
meichuanyi wants to merge 1 commit into
kernel:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

@meichuanyi meichuanyi commented May 29, 2026

Summary

Add comprehensive FAQ section covering Kernel sandboxed Chrome browsers:

  • What is Kernel? (sandboxed Chrome for automations/web agents)
  • Key Features (Remote GUI/Video Replays/Unikernel benefits)
  • Installation (Docker + Unikraft unikernel)
  • Requirements (8GB memory/TURN server/Kraft CLI)
  • Use Cases (Browser automations/AI agents/Custom tools)
  • License and Help resources

Changes

  • Add ~70 line FAQ section with structured tables
  • Include Docker and Unikraft quick start commands
  • Add unikernel-specific notes and WebRTC requirements
  • Link to hosted services and community channels

Checklist

  • Documentation improvement
  • No code changes
  • Follows existing README format

Note

Low Risk
Documentation-only change to README.md with no runtime or security impact.

Overview
Adds a new FAQ section at the end of README.md (after the Colophon), packaging onboarding and reference material in one place for readers who skip the long body above.

The FAQ restates what Kernel is, features, Docker and Unikraft install commands, requirements (memory, WebRTC/TURN, Kraft, UKC secrets, VCPUS), use cases, license, and a help/resources table with links to docs, signup, Discord, Twitter, and GitHub issues. Much of this mirrors earlier README sections but uses tables and shorter copy for quick scanning.

Reviewed by Cursor Bugbot for commit 6978ee8. Bugbot is set up for automated code reviews on this repo. Configure here.

@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

PRs in the kernel, infra, hypeman, and hypeship repos. kernel is a ~mono repo with many logical services underneath, ensure to focus on the implicated service for the PR

Reason: PR is documentation-only (FAQ section) with no code changes, so does not require deploy monitoring even though it's in the kernel repo.

To monitor this PR anyway, reply with @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 6978ee8. Configure here.

Comment thread README.md
| **Sign Up** | [www.kernel.sh](https://www.kernel.sh/) |
| **Discord** | [discord.gg/FBrveQRcud](https://discord.gg/FBrveQRcud) |
| **Twitter** | [@juecd__](https://x.com/juecd__), [@rfgarcia](https://x.com/rfgarcia) |
| **Issues** | [GitHub Issues](https://github.com/kernel/kernel-images/issues) |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

FAQ section duplicates content from same file

Low Severity

The entire FAQ section restates information already present earlier in the same README file — "What is Kernel?", "Key Features", "Installation", "Use Cases", "License", and "Help & Resources" all duplicate existing sections. This doubles the maintenance surface in one file, and the build/run mismatch bug already demonstrates how duplicated content drifts out of sync.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 6978ee8. Configure here.

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.

1 participant