Update documentation and examples for clarity and consistency

[yamcodes]

• Removed the icon from the examples page for a cleaner look.
• Updated the index page to include a new "Start with an example" card, enhancing navigation for users.
• Adjusted the icon for the ArkType Documentation card to a globe for better representation.
• Simplified descriptions in the quickstart page to improve readability and user engagement.
• Standardized the integration section in meta.json for better organization.

These changes aim to improve the user experience and streamline the documentation structure.

Summary by CodeRabbit

• Documentation
  • Quickstart: streamlined tone, updated card titles/descriptions, removed icons, retitled “How to load environment variables.”
  • Added a “Start with an example” card linking to examples.
  • Morphs guide: updated usage examples and API import style.
  • Docs index: adjusted icons/labels (ArkType now Globe) and removed the Quickstart icon.
  • Integrations navigation reorganized for clarity (VS Code & Cursor, JetBrains IDEs).
  • Examples page metadata: removed an unused icon field.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f9e16ac

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]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
arkenv	Ready	Preview	Comment	Oct 13, 2025 2:02pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation updates: adjusted icons and Card entries on docs pages, reorganized the Integrations navigation entries in meta.json, removed a front-matter icon field from examples, and updated examples/docs to reflect an arkenv API import change (from a plain default import to importing the default plus a named type).

Changes

Cohort / File(s)	Summary of Changes
Index & Quickstart cards apps/www/content/docs/index.mdx, apps/www/content/docs/quickstart.mdx	Updated imported lucide-react icons; removed several icon props from Card components; added a “Start with an example” Card linking to /docs/examples; adjusted Card titles and descriptions (including renaming “Load environment variables” → “How to load environment variables”).
Docs navigation / integrations apps/www/content/docs/meta.json	Reorganized Integrations section: removed the previous "[New]Integrations" heading and nested blocks, replaced with a single "Integrations" heading and simplified entries for "[VS Code & Cursor]" and "[JetBrains IDEs]".
Morphs page / API usage apps/www/content/docs/morphs.mdx	Replaced prior default-only import examples with import arkenv, { type } from 'arkenv' usage and updated example text; changed header icon from WandSparkles to New.
Examples metadata apps/www/content/docs/examples.mdx	Removed icon: FolderCode from YAML front matter (no other content changes).

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Dev as Developer
  participant Docs as Docs pages
  participant Pkg as arkenv package

  Dev->>Docs: update examples and docs imports
  Docs->>Pkg: show usage: import arkenv, { type } from 'arkenv'
  Note over Docs,Pkg: documentation reflects new import surface (default + named `type`)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• Export createEnv as the default export #136 — Changes to arkenv export surface that align with documentation import updates (default + named exports).
• Integration docs #154 — Modifies docs/meta.json and navigation entries similar to this PR’s Integrations reorganization.
• Docs improvements #155 — Related website docs updates (cards/pages) touching the same docs area.

Poem

A hop, a nibble, docs made neat,
I swapped an icon and tuned a beat.
Cards rearranged, integrations aligned,
arkenv’s import now clearly defined.
Hooray — a rabbit’s tidy commit! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title accurately conveys the primary focus of the changeset, which is updating documentation and examples to improve clarity and consistency. It is concise and directly reflects the modifications described in the PR summary without extraneous details. This makes it easy for reviewers and future readers to understand the purpose of the pull request at a glance.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 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 e55885b and f9e16ac.

📒 Files selected for processing (1)

• apps/www/content/docs/morphs.mdx (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (3)

apps/www/content/docs/index.mdx (1)

5-5: Remove unused icon imports

BookOpen and Rocket aren’t used anymore; trim to avoid lint warnings/bundle bloat.

-import { BookOpen, Rocket, Globe } from "lucide-react";
+import { Globe } from "lucide-react";

apps/www/content/docs/quickstart.mdx (2)

133-133: Align examples with createEnv API

Elsewhere docs switch to createEnv, but this page still shows default arkenv in the code samples (Lines 39 and 112). Update both blocks for consistency.

For the “Define the schema” block:

-import arkenv, { type } from 'arkenv';
-
-export const env = arkenv({
+import { createEnv, type } from 'arkenv';
+
+export const env = createEnv({
   // Built-in validators
   DATABASE_HOST: "string.host",
   ...
 });

For the “Use in your code” block:

-import arkenv from 'arkenv';
-export const env = arkenv({
+import { createEnv } from 'arkenv';
+export const env = createEnv({
   DATABASE_HOST: "string.host",
   ...
 });

---

149-152: Fix examples link: remove unnecessary fragment

Use the same path as index.mdx to avoid a potentially broken anchor.

-  href="/docs/examples#examples"
+  href="/docs/examples"

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0769ba2 and e55885b.

📒 Files selected for processing (5)

• apps/www/content/docs/examples.mdx (0 hunks)
• apps/www/content/docs/index.mdx (2 hunks)
• apps/www/content/docs/meta.json (1 hunks)
• apps/www/content/docs/morphs.mdx (2 hunks)
• apps/www/content/docs/quickstart.mdx (1 hunks)

💤 Files with no reviewable changes (1)

• apps/www/content/docs/examples.mdx

🔇 Additional comments (4)

apps/www/content/docs/meta.json (1)

9-11: Integrations nav simplification looks good

Clearer section header and direct links improve readability.

apps/www/content/docs/index.mdx (1)

14-18: Cards update reads well

Quickstart without icon + new Examples card + Globe for ArkType are consistent with the simplified design.

apps/www/content/docs/quickstart.mdx (2)

141-147: Copy changes LGTM

Concise descriptions improve scannability.

---

154-154: Card title matches How-to page

Consistent with the How-to section naming.