Skip to content

docs(fast-check): add package README and integrations docs - #1629

Open
radhityaz wants to merge 1 commit into
arktypeio:mainfrom
radhityaz:docs/fast-check
Open

radhityaz wants to merge 1 commit into
arktypeio:mainfrom
radhityaz:docs/fast-check

Conversation

@radhityaz

Copy link
Copy Markdown

Summary

  • Add a package README for @ark/fast-check with install steps, arkToArbitrary usage, supported schema categories, and unsupported-schema behavior.
  • Document the integration on arktype.io under Integrations, including sidebar navigation.
  • Update llms.txt so the new integrations content is included in exported docs.

Closes #1243

Test plan

  • pnpm exec prettier --check on edited formattable files
  • pnpm --filter @ark/docs build

Made with Cursor

Document @ark/fast-check usage for property-based testing so adopters can find install steps, arkToArbitrary examples, and supported schema coverage.

Closes arktypeio#1243

Co-authored-by: Cursor <cursoragent@cursor.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.

✅ No new issues found.

Reviewed changes — adds package README for @ark/fast-check and integrations documentation on arktype.io.

  • ark/fast-check/README.md — new README covering install, arkToArbitrary usage, and supported schema categories.
  • ark/docs/content/docs/integrations/index.mdx — new fast-check section with code example and link to the package README.
  • ark/docs/content/docs/integrations/meta.json — sidebar entry for fast-check.
  • ark/docs/public/llms.txt — mirrored integrations content for LLM export.

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

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To do

Development

Successfully merging this pull request may close these issues.

@ark/fast-check docs

1 participant