Skip to content

docs: Translate the quickstart into one language — first-time contributors welcome #72

Description

@aoto-tech

One language, one short page, one PR

Help a developer try CellFence in a language they read comfortably.

Translate the short getting-started flow—not the entire README. No engine knowledge or bug hunting is needed. First-time contributors, AI-assisted contributors, and coding agents are welcome. The submitted language and technical instructions must be checked.

This is a rolling contribution issue: multiple contributors, no deadline, no contributor limit, and no assigned owner.

Pick a language

Create docs/i18n/<language>/quickstart.md. For example:

Language File
Japanese / 日本語 docs/i18n/ja/quickstart.md
Simplified Chinese / 简体中文 docs/i18n/zh-CN/quickstart.md
Spanish / Español docs/i18n/es/quickstart.md
Brazilian Portuguese / Português brasileiro docs/i18n/pt-BR/quickstart.md
French / Français docs/i18n/fr/quickstart.md
German / Deutsch docs/i18n/de/quickstart.md

Other languages are welcome. These are starting points, not reservations. Check the current files and open PRs before choosing. If a translation already exists, a concrete correction or missing section is welcome; do not submit a duplicate page.

What the page should contain

Use the current English README as the source:

  1. What CellFence does: a short introduction explaining repository architecture checks and private cross-cell imports.
  2. Try it in sixty seconds: translate the explanation and preserve the working commands.
  3. Try it in an existing repository: explain init --no-scaffold, the need to review the inferred manifest, and the first check.
  4. Limits and next steps: mention pre-release status, supported Node.js requirements, and that CellFence is not a runtime sandbox or a guarantee of functional correctness. Link to the English limitations and CI guide.

Keep it short. The full CLI reference, comparison table, research material, and architecture graph are outside this task.

At the top, identify this as a community translation and link to the English source. Record the source commit used in the PR description so reviewers can compare the wording.

Keep commands, filenames, JSON keys, rule IDs, package names, and quoted CLI output unchanged. Translate surrounding explanations naturally. Adjust relative links for the new directory.

Add one link to your page under a small Translated quickstarts section near the end of the root README. Reuse that section if another PR has already created it. The expected change is the translated page and this discovery link.

Validation

Run the documented quickstart commands in a disposable directory, and check that the instructions for an existing repository match the current English flow. Record the Node.js and installed CellFence versions, commands, and actual outcomes in the PR.

From your CellFence checkout, run:

node --test tests/readme-links.test.mjs
git diff --check

Also inspect links inside the translated page; the existing README-link test is not proof that all nested documentation links work.

This is documentation-only work. Follow the focused-validation allowance in CONTRIBUTING.md and AGENTS.md. Report any checks you could not run. If a published package behaves differently from the source documentation, describe the mismatch instead of claiming the commands passed.

Submit

  1. Fork CellFence.
  2. Add or improve one language's quickstart and its README link.
  3. Open one focused PR and link this issue with Refs, not a closing keyword.

No assignment, reservation, or advance comment is required for this rolling issue. This is an explicit exception to the general “comment before starting” workflow. Different languages can proceed independently. This issue stays open after individual PRs merge.

Acceptance criteria

  • One useful translation or substantive improvement, checked for natural language and technical accuracy.
  • Commands, identifiers, limitations, and claims agree with the English source.
  • The page links to its source and is discoverable from the root README.
  • The PR records the source commit, actual validation, and any skipped checks.
  • No duplicate translation, engine changes, generated output, or unrelated refactoring.

Related: #45 covers fixture explanations, #46 covers rule walkthroughs, and #47 covers framework examples. This issue is specifically for translated onboarding.


If you find CellFence useful, consider starring the repository. If this contribution topic interests you, give this issue a 👍. Both are optional and are not required to contribute.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions