Assorted content updates to Website, README, and Welcome Docs#1590
Assorted content updates to Website, README, and Welcome Docs#1590anthonyiscoding wants to merge 6 commits intomainfrom
Conversation
- Override .xp-trace-actions .continue-link to use filled button style matching deploy/send buttons, with correct hover text color - Remove text-transform:uppercase from .xp-trace .head .label so "iii console" renders in correct case
- Add important callout directing users to Quickstart and iii experience - Clarify the quadratic integration cost explanation - Add section about pre-built workers and workers.iii.dev - Remove redundant Examples section (covered by callout)
Rewrites the docs landing page to align with the iii manifesto and website messaging. Covers the core problem (quadratic integration cost), the three primitives, execution model, live system traits, and the agent-native design philosophy.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
anthonyiscoding
changed the title
GitHub requires the alert type on its own line, but Prettier collapses it. Added ignore comment to preserve formatting.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 16-19: Fix the typo in the README sentence "If you want an even
shorter introduction the try the simulated [iii experience]..." by removing the
extra "the" and adding the missing comma: change it to "If you want an even
shorter introduction, try the simulated [iii experience]..." so the phrase in
the prominent callout reads correctly.
- Around line 32-35: Replace the incorrect phrase "We also ships workers with
more being added all the time." in the README paragraph with a grammatically
correct version such as "We also ship workers, with more being added all the
time." to fix the subject-verb agreement; update the sentence that begins with
"We also ships workers" so it reads "We also ship workers..." and keep the rest
of the sentence unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 4d6cfc12-d7fa-4967-bfe6-596e795383d6
📒 Files selected for processing (3)
README.mddocs/index.mdxwebsite/index.html
| > The best way to understand iii is to | ||
| > [try our Quickstart](https://iii.dev/docs/quickstart), it will take just two minutes and may | ||
| > forever change how you build software. If you want an even shorter introduction the try the | ||
| > simulated [iii experience](https://iii.dev/#experience). |
There was a problem hiding this comment.
Fix typo in the IMPORTANT callout sentence.
Line 18 has “the try the”, which reads as a typo and breaks flow in the most prominent block.
Suggested edit
-> forever change how you build software. If you want an even shorter introduction the try the
+> forever change how you build software. If you want an even shorter introduction, try the📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > The best way to understand iii is to | |
| > [try our Quickstart](https://iii.dev/docs/quickstart), it will take just two minutes and may | |
| > forever change how you build software. If you want an even shorter introduction the try the | |
| > simulated [iii experience](https://iii.dev/#experience). | |
| > The best way to understand iii is to | |
| > [try our Quickstart](https://iii.dev/docs/quickstart), it will take just two minutes and may | |
| > forever change how you build software. If you want an even shorter introduction, try the | |
| > simulated [iii experience](https://iii.dev/#experience). |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 16 - 19, Fix the typo in the README sentence "If you
want an even shorter introduction the try the simulated [iii experience]..." by
removing the extra "the" and adding the missing comma: change it to "If you want
an even shorter introduction, try the simulated [iii experience]..." so the
phrase in the prominent callout reads correctly.
| We also ships workers with more being added all the time. You can browse our worker repository at | ||
| [workers.iii.dev](https://workers.iii.dev/). Adding any of them to a system is as easy as installing | ||
| a library or package and can be done with the command `iii worker add iii-sandbox`, or `iii-queue`, | ||
| or `iii-stream`. New infrastructure-level and service-level workers are being added all of the time. |
There was a problem hiding this comment.
Correct subject-verb agreement in worker repository paragraph.
Line 32 uses “We also ships workers”, which is grammatically incorrect in user-facing docs.
Suggested edit
-We also ships workers with more being added all the time. You can browse our worker repository at
+We also ship workers, with more being added all the time. You can browse our worker repository at🧰 Tools
🪛 LanguageTool
[style] ~35-~35: Consider removing “of” to be more concise
Context: ...d service-level workers are being added all of the time. The structure of workers enables...
(ALL_OF_THE)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 32 - 35, Replace the incorrect phrase "We also ships
workers with more being added all the time." in the README paragraph with a
grammatically correct version such as "We also ship workers, with more being
added all the time." to fix the subject-verb agreement; update the sentence that
begins with "We also ships workers" so it reads "We also ship workers..." and
keep the rest of the sentence unchanged.
Add upstream/downstream friction framing to explain the full scope of integration problems iii solves.
1 participant
Summary by CodeRabbit
Documentation
Style