Skip to content

Add bilingual English/Kriolu documentation - #1

Merged
joaquimscosta merged 7 commits into
mainfrom
feat/001-kriolu-documentation
May 20, 2026
Merged

Add bilingual English/Kriolu documentation#1
joaquimscosta merged 7 commits into
mainfrom
feat/001-kriolu-documentation

Conversation

@joaquimscosta

Copy link
Copy Markdown
Contributor

Summary

  • Adds Kriolu (ALUPEC orthography) translations of README, CONTRIBUTING, PR templates, issue template, and _example/ docs as sibling .kea.md files
  • Adds language-picker headers in both directions (English → Kriolu and Kriolu → English)
  • Clarifies that the CC BY-SA 4.0 license in this repo covers documentation as well as presets
  • Documents the ?template=<filename>.md URL pattern in CONTRIBUTING.md for selecting Kriolu PR templates (GitHub doesn't auto-surface a picker for PR templates when multiple exist; only the issue-template picker does)

Every .kea.md file opens with a > **DRAFT — needs native-speaker review.** Pull requests welcome. banner. These are first drafts authored mechanically following two rules: (1) ALUPEC orthography, (2) keep English for git/GitHub/JSON/CI terminology and translate everything else. They should be polished by native Kriolu speakers before the banner is removed.

Files

New (Kriolu drafts):

  • README.kea.md
  • CONTRIBUTING.kea.md
  • .github/PULL_REQUEST_TEMPLATE/new-preset.kea.md
  • .github/PULL_REQUEST_TEMPLATE/update-preset.kea.md
  • .github/ISSUE_TEMPLATE/preset-request.kea.md
  • presets/_example/README.kea.md
  • presets/_example/CHANGELOG.kea.md

Modified (English):

  • README.md — picker header + license clause now covers docs
  • CONTRIBUTING.md — picker header + ?template=… URL guidance
  • .github/PULL_REQUEST_TEMPLATE/new-preset.md — picker header
  • .github/PULL_REQUEST_TEMPLATE/update-preset.md — picker header
  • .github/ISSUE_TEMPLATE/preset-request.md — picker header
  • presets/_example/README.md — picker header

Test plan

  • Verify README.mdREADME.kea.md picker links render correctly on GitHub
  • Verify same for CONTRIBUTING.mdCONTRIBUTING.kea.md and the four templates
  • Confirm preset-request.kea.md appears as a separate choice in GitHub's issue-template picker
  • Test the ?template=new-preset.kea.md URL pattern on a throwaway PR
  • Native Kriolu speaker review of all seven .kea.md drafts; remove DRAFT banner once polished

Known limitation

PR-template Kriolu variants (*.kea.md) won't auto-surface in GitHub's UI — contributors need the documented ?template=… URL. Only the issue-template Kriolu variant gets a proper picker entry. This is GitHub's behavior, not something this PR can fix.

Translate README, CONTRIBUTING, PR/issue templates, and _example docs
to Kriolu (ALUPEC orthography). All .kea.md files marked as drafts
pending native-speaker review.

Also:
- Add language-picker headers to English and Kriolu versions
- Clarify README license clause covers documentation as well as presets
- Document ?template=<filename>.md URL pattern in CONTRIBUTING for
  selecting a specific PR template (GitHub doesn't show a picker
  for PR templates when multiple exist)
Wire up cspell to validate ALUPEC spelling on .kea documentation files.

- Add @papia/cspell-kea devDependency (^2.0.2)
- Configure .cspell.json at root to import the kea dictionary
- Configure presets/_example/.cspell.json scoped to *.kea.{md,mdx}
Apply ALUPEC-compliant corrections to Kriolu documentation surfaced by
the kriolu-proofread tool.

- CONTRIBUTING.kea.md, presets/_example/README.kea.md and CHANGELOG.kea.md:
  normalize -ção → -san, ch → tx digraphs, fitxeru → fixeru, opsão → opsan,
  and other ALUPEC spellings; soften tone in code-of-conduct section
- Track proofread runs in .kriolu/ledger.jsonl and .kriolu/seen-runs.txt
Workflows configure actions/setup-node with cache: pnpm, which requires
pnpm-lock.yaml. The repo had package-lock.json from an accidental npm
install, causing Setup Node to fail before pnpm install could run.

- Remove package-lock.json
- Add pnpm-lock.yaml (lockfileVersion 9.0, compatible with CI pnpm v9)
- Ignore package-lock.json and yarn.lock to prevent recurrence
GitHub deprecated Node 20 action runtimes (default switch June 2026,
removal September 2026). Bump to the v6 majors which run on Node 24,
and switch the project's runner Node from 20 to 24 (engines: >=20).

- actions/checkout: v4 -> v6
- actions/setup-node: v4 -> v6
- pnpm/action-setup: v3 -> v6
- node-version: 20 -> 24
@joaquimscosta
joaquimscosta merged commit fd8daeb into main May 20, 2026
1 check passed
@joaquimscosta
joaquimscosta deleted the feat/001-kriolu-documentation branch May 20, 2026 02:31
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