Skip to content

feat: add Chinese language support and translate content #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dowithless
Copy link

@dowithless dowithless commented May 18, 2025

This commit introduces Chinese language support to the documentation site by adding a new locale configuration in the VitePress config file. It also includes the translation of all documentation pages into Chinese

The changes include:

  • Added Chinese locale configuration in .vitepress/config.mts
  • Translated all documentation pages into Chinese
  • Added Chinese navigation and sidebar configurations

This enhancement aims to make the Farcaster documentation more accessible to Chinese-speaking developers and users.

You can view the deployed effect here: https://docs-farcaster-xyz.vercel.app/zh/


PR-Codex overview

This PR focuses on enhancing the documentation for the Farcaster project, including updates to guides, API references, and the introduction of new features like Mini Apps, as well as links to external resources.

Detailed summary

  • Added links to resources in utilities.md.
  • Updated package.json with new package manager info.
  • Enhanced guides on submitting data and replicating Hubble data.
  • Detailed Fids API and Info API specifications.
  • Introduced new sections on Warpcast embedding and event API.
  • Updated navigation in .vitepress/zh.nav.js.
  • Revised content in various developer guides and reference documents.
  • Introduced new tutorial links for setting up Hubble instances.

The following files were skipped due to too many changes: docs/zh/learn/architecture/hubs.md, docs/zh/developers/guides/accounts/change-recovery.md, docs/zh/reference/hubble/httpapi/userdata.md, docs/zh/reference/contracts/reference/storage-registry.md, docs/zh/developers/frames/resources.md, docs/zh/developers/frames/best-practices.md, docs/zh/developers/resources.md, docs/zh/hubble/migrating.md, docs/zh/developers/frames/getting-started.md, docs/zh/learn/what-is-farcaster/accounts.md, docs/zh/auth-kit/client/app/verify-sign-in-message.md, docs/zh/reference/hubble/grpcapi/links.md, docs/zh/auth-kit/sign-in-button.md, docs/zh/auth-kit/client/app/create-channel.md, docs/zh/reference/hubble/grpcapi/usernameproof.md, docs/zh/reference/hubble/grpcapi/onchain.md, docs/zh/auth-kit/client/wallet/build-sign-in-message.md, docs/zh/learn/what-is-farcaster/usernames.md, docs/zh/developers/guides/writing/casts.md, docs/zh/developers/guides/accounts/change-custody.md, docs/zh/hubble/tutorials/gcp.md, docs/zh/reference/hubble/httpapi/links.md, docs/zh/learn/contributing/fips.md, docs/zh/auth-kit/client/app/status.md, docs/zh/developers/guides/writing/verify-address.md, docs/zh/reference/fname/api.md, docs/zh/developers/guides/writing/messages.md, docs/zh/reference/contracts/faq.md, docs/zh/learn/what-is-farcaster/messages.md, docs/zh/developers/guides/querying/fetch-channel-casts.md, docs/zh/reference/hubble/grpcapi/reactions.md, docs/zh/reference/hubble/httpapi/onchain.md, docs/zh/reference/hubble/httpapi/httpapi.md, docs/zh/auth-kit/client/wallet/authenticate.md, docs/zh/auth-kit/client/app/watch-status.md, docs/zh/hubble/install.md, docs/zh/reference/hubble/httpapi/casts.md, docs/zh/reference/contracts/reference/bundler.md, docs/zh/reference/hubble/grpcapi/sync.md, docs/zh/developers/guides/apps/feed.md, docs/zh/reference/contracts/reference/id-gateway.md, docs/zh/reference/hubble/httpapi/reactions.md, docs/zh/auth-kit/hooks/use-sign-in.md, docs/zh/reference/contracts/reference/key-registry.md, docs/zh/reference/hubble/httpapi/message.md, docs/zh/reference/actions/spec.md, docs/zh/reference/contracts/reference/signed-key-request-validator.md, docs/zh/developers/guides/basics/hello-world.md, docs/zh/reference/contracts/reference/key-gateway.md, docs/zh/reference/warpcast/signer-requests.md, docs/zh/reference/warpcast/signers.md, docs/zh/developers/guides/accounts/create-account-key.md, docs/zh/reference/hubble/datatypes/events.md, docs/zh/reference/warpcast/api.md, docs/zh/developers/guides/accounts/create-account.md, docs/zh/developers/frames/spec.md, docs/.vitepress/zh.sidebar.js, docs/zh/reference/hubble/datatypes/messages.md, docs/zh/reference/contracts/reference/id-registry.md, docs/zh/reference/replicator/schema.md

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

This commit introduces Chinese language support to the documentation site by adding a new locale configuration in the VitePress config file.
It also includes the translation of all documentation pages into Chinese

The changes include:
- Added Chinese locale configuration in `.vitepress/config.mts`
- Translated all documentation pages into Chinese
- Added Chinese navigation and sidebar configurations

This enhancement aims to make the Farcaster documentation more accessible to Chinese-speaking developers and users.
Copy link

vercel bot commented May 18, 2025

@dowithless is attempting to deploy a commit to the farcaster Team on Vercel.

A member of the Team first needs to authorize it.

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