Commit Graph
32 Commits
Author SHA1 Message Date
gorkem-bwl 0b09895098 docs: align dev setup docs with current server config
## Changes
- Replace stale QUEUE_TYPE env var (superSimpleQueue/lessSimpleQueue) with QUEUE_MODE (primary/worker) to match server/src/config/envValidation.ts
- Mark ORIGIN, TOKEN_TTL and LOG_LEVEL as optional with their defaults; note that only CLIENT_HOST, JWT_SECRET and DB_CONNECTION_STRING are strictly required
- Note that CLIENT_HOST must be a full URL (enforced by env validation)
- Remove Redis port 6379 from the port-conflict troubleshooting list; the server has no Redis dependency
- Point CLAUDE.md at CONTRIBUTING.md as the setup source of truth

## Why
A contributor followed the setup docs and hit references to files and env vars that no longer exist after the repo reorg. This brings the contributor docs in line with the actual dev workflow.
2026-07-21 19:44:22 +03:00
Alexander Holliday fe703199f5 Merge pull request #3776 from bluewave-labs/chore/simplify-deployment
chore: simplify deployment
2026-07-13 09:57:13 -07:00
gorkem-bwl 523bf2253c feat(i18n): add Italian translation, document translation workflow
## Changes

- Add `client/src/locales/it.json` — Italian translation of all 874 UI
  keys, structure mirrors `en.json` exactly. Placeholders (`{{value}}`,
  etc.) and inline tag tokens (`<settingsLink>`, `<highlight>`, ...)
  are preserved. Product/brand names, technical abbreviations, and
  placeholder-style examples (e.g. `you@example.com`) are kept in
  English. 116 leaves are intentionally kept verbatim in English
  (brand names, protocol names, sample values, port numbers, regex).
- Register `it: "Italiano"` in `LanguageSelector`'s `languageNames`
  map so the dropdown shows the localised name; the selector already
  picks up any locale present in the i18n resources.
- Fill in the two "How do I..." sections that CONTRIBUTING.md's table
  of contents already links to but did not have bodies:
  - "Improve the documentation?" — short guidance on doc PRs and
    keeping README translations in sync.
  - "Help with translations?" — describes the current per-language
    JSON workflow (source of truth: `en.json`; improve an existing
    language by editing its JSON; add a new one by adding a JSON file
    and registering the display name in `LanguageSelector`). Notes
    that the older PoEditor sync workflow is no longer authoritative.

## Benefits

- Italian speakers can now use Checkmate in Italian.
- Contributors who follow the "Help with translations?" link from
  the CONTRIBUTING TOC land on real, current guidance instead of a
  broken anchor.
- Translation quality can be improved incrementally by anyone
  editing `it.json` directly; no external tooling required.
2026-07-13 16:10:04 +03:00
Alex Holliday bbb051406f udpate docs 2026-07-09 10:21:09 -07:00
Alex Holliday 4280a6c2c3 update env vars 2026-05-29 10:34:42 -07:00
Gorkem Cetin aee81a03fa Merge pull request #3588 from bluewave-labs/docs/contributing-redis-formatcheck
docs: align CONTRIBUTING.md and CLAUDE.md with current toolchain
2026-04-28 00:00:25 -04:00
gorkem-bwl 40bcf7f6ac docs: align CONTRIBUTING.md and CLAUDE.md with current toolchain
CONTRIBUTING.md: surface format-check + build in code guidelines
and the PR checklist so contributors run the same verifications
the project enforces locally.

CLAUDE.md: correct stale test framework reference (Mocha+Chai+Sinon
-> Jest) and update the test file glob to server/test/**/*.test.ts.
2026-04-27 23:50:01 -04:00
Gorkem Cetin a706e68c6a Remove documentation and translation improvement sections
Removed sections about improving documentation and translations from the contributing guidelines.
2026-04-27 23:38:37 -04:00
Gorkem Cetin 29f1041cc3 Merge pull request #3578 from ZeinebMegaadi/fix/docs-link
fix:replaced the broken link with the working one everywhere
2026-04-25 19:40:31 -04:00
ZeinebMegaadi a613bfb45a fix:replaced the broken link with the working one everywhere 2026-04-25 15:33:42 +01:00
Alexander Holliday 33110cf6c8 Merge pull request #3545 from ZeinebMegaadi/fix/node-version-docs
docs: update Node.js version requirement to >=20 in contributing guide
2026-04-20 09:35:04 -07:00
ZeinebMegaadi 7906fce77f docs: update Node.js version requirement to >=20 in contributing guide 2026-04-17 21:17:40 +01:00
SkyKingPX 10a703d657 Update CONTRIBUTING.md 2026-04-16 13:49:58 +02:00
SuryaGanesh284 6c2908681a Add quick setup checklist to CONTRIBUTING.md
Added a quick setup checklist for contributors.
2025-11-25 22:12:16 +05:30
Alexander Holliday 4db13fb924 Update CONTRIBUTING.md 2025-11-12 09:21:02 -08:00
Yura 7763c5e288 Fix the location from the docker images installation and addition of a solution from a problem i saw while installing the front 2025-11-09 01:15:05 -05:00
Yura 957988d977 Fix the location from the docker images installation and addition of a solution from a problem i saw while installing the front 2025-11-09 01:08:56 -05:00
Gorkem Cetin (BWL) 2d29bce97b Update CONTRIBUTING.md 2025-10-06 12:35:23 -04:00
jithendra Kavala 080a33fac7 docs: improve local development setup instructions in CONTRIBUTING.md 2025-10-02 13:51:30 +05:30
Alexander Holliday 370584c501 Merge branch 'master' into develop 2025-05-13 13:28:18 -07:00
Gorkem Cetin (BWL) e8c9de6c63 Fix after repo merge + add Devin link for Checkmate 2025-04-26 19:50:41 -04:00
Aryaman Kumar Sharma 91dee2b8ec Fix: Move MD Files from client to main dir 2025-04-21 21:28:02 +05:30
Alex Holliday 8b7e3c650b restore repo structure 2025-04-20 11:29:53 -07:00
Gorkem Cetin (BWL) cadfbb013a Assurance added 2025-04-12 17:32:05 -04:00
Gorkem Cetin (BWL) b177b5f357 A better guide to contribute to Checkmate 2025-03-29 19:41:10 -04:00
Gorkem Cetin (BWL) 41170f16bc Update CONTRIBUTING.md 2025-03-01 15:49:01 -05:00
Gorkem Cetin (BWL) 0476644f44 Update for name changes 2024-12-13 22:43:54 -05:00
Gorkem Cetin (BWL) 8f9fa11b9d Update CONTRIBUTING.md 2024-10-15 12:03:19 -04:00
Gorkem Cetin (BWL) 9fef75e824 Fix for contributing.md 2024-06-30 21:36:29 -04:00
Gorkem Cetin (BWL) 8e7c6ceb99 Updates to CONTRIBUTING.md 2024-06-30 21:30:46 -04:00
Gorkem Cetin (BWL) eb9201b6e2 Update CONTRIBUTING.md 2024-06-15 11:01:15 -04:00
Gorkem Cetin (BWL) f827293a12 Create CONTRIBUTING.md
This is a very basic version. It will probably be in a better shape after our first MVP where we have a working version together with an installation/usage documentation as well.
2024-06-13 13:55:11 -04:00