Skip to content

docs: remove deprecated validator references - #1830

Merged
yamcodes merged 2 commits into
v1from
yamcodes-remove-doc-validator-references
Sep 11, 2026
Merged

docs: remove deprecated validator references#1830
yamcodes merged 2 commits into
v1from
yamcodes-remove-doc-validator-references

Conversation

@yamcodes

Copy link
Copy Markdown
Owner

Summary

  • remove Typia from the DIY validation example
  • remove Joi from the NestJS guidance
  • remove Yup from the Standard Schema ADR example

Validation

  • git diff --check
  • verified no typia, yup, or joi references remain under apps/www/content/docs or docs

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added docs Adds or changes documentation, or acts as documentation in and of itself www Improvements or additions to arkenv.js.org labels Sep 11, 2026
@changeset-bot

changeset-bot Bot commented Sep 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: ad42c3f

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

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ℹ️ Minor suggestions — one consistency question plus a framing note, nothing blocking.

Reviewed changes

  • NestJS guide (use-with-nestjs.mdx): dropped the Joi mention — the @nestjs/config v11 sentence now reads "validationSchema doesn't support Standard Schema validators."
  • DIY section (why-arkenv.mdx): removed Typia from the validator list, reformatted cleanly.
  • ADR 0029: removed /yup from the hypothetical /zod-proliferation example (keeping /typebox, /arktype).

All three edits are accurate and consistent with the docs' first-class validator set (ArkType, Zod, Valibot), and your verification holds: no typia/joi/yup references remain under apps/www/content/docs or docs. The reflowed prose also stays within the surrounding line-length convention.

ℹ️ Homepage "Works with" marquee still lists Typia

apps/www/components/page/works-with.tsx still features Typia prominently in the hero trust-bar marquee (lines 51–53, via typia-icon.tsx, with the comment on line 33 explicitly calling out "Valibot, Typia"). The homepage is now the strongest public "ArkEnv works with Typia" claim in the repo — a stronger statement than the docs prose ever made. If the intent is to stop referencing Typia, the homepage is the one surface that contradicts it; if the marquee is deliberately a broad-ecosystem surface while docs speak to the first-class set, that's a fine distinction to document instead.

Technical details
# Homepage Typia marquee vs docs cleanup

## Affected sites
- apps/www/components/page/works-with.tsx:51-53 — `Typia` / `TypiaIcon` entry in `worksWith[]`
- apps/www/components/icons/typia-icon.tsx — icon asset (only used by the marquee)
- apps/www/components/page/works-with.tsx:33 — comment asserting the list includes "Valibot, Typia"

## Required outcome
- Either drop Typia from the marquee (and delete `typia-icon.tsx` if it becomes unused) to match the docs cleanup, or keep both intentionally and note that the marquee is an ecosystem-breadth surface distinct from the docs' supported-validator set. The author's call; text should not silently diverge.

ℹ️ "Deprecated validator" framing is imprecise — Joi isn't deprecated

Joi is not an ecosystem-deprecated or withdrawn library — this repo actively supports it: the pending changeset .changeset/pre/json-schema-draft-fallback.md (and packages/standard/CHANGELOG.md) describes Joi as a supported @arkenv/standard JSON-Schema converter ("for example Joi, which can now use root @arkenv/standard..."). The NestJS rephrase itself is factually correct, so this needs no code change — it's a premise note: these edits are best described as de-emphasizing non-first-class validators in docs prose rather than "removing deprecated validator references." Worth keeping in mind so a future pass doesn't "clean up" the Joi support in the standard package or the NestJS guidance loses the (fairly informative) historical note for v11 users.

Pullfrog  | Fix it ➔View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ No new issues found.

Reviewed changes (delta since the prior pullfrog review)

  • Deleted apps/www/components/icons/joi-icon.tsx and apps/www/components/icons/typia-icon.tsx — both now unreferenced; repo-wide grep confirms zero remaining TypiaIcon/JoiIcon/typia-icon/joi-icon references, and the icons directory has no barrel that would dangle.
  • apps/www/components/page/works-with.tsx: removed the Typia marquee entry, its import, and the comment mention. The hero trust bar now lists ArkType, Zod, Valibot followed by runtimes/editors/hosts, and the comment accurately reflects that.

This resolves the one actionable item from the prior review (the homepage "Works with" marquee still listing Typia). The earlier framing note about Joi being a supported @arkenv/standard converter was informational only and needed no change — the NestJS rephrase remains factually accurate either way.

Pullfrog  | View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

@yamcodes
yamcodes merged commit b26786b into v1 Sep 11, 2026
16 checks passed
@yamcodes
yamcodes deleted the yamcodes-remove-doc-validator-references branch September 11, 2026 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Adds or changes documentation, or acts as documentation in and of itself www Improvements or additions to arkenv.js.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant