This folder groups every piece of documentation aimed at end-users (QA, developers) and instance administrators. It is split in two blocks:
- User manual — features available in the current release.
- Architecture — backend + frontend project structure, conventions, and data model. Useful for contributors and LLM assistants.
- Planned features — skeleton of roadmap items that are not yet implemented. Useful to understand where the product is heading and to anticipate integrations.
Spanish translation: README.es.md.
Available UI languages: English (en, default), Spanish (es), Catalan (ca), Galician (gl), Basque (eu). Switch under Profile → Appearance → Language. The choice persists on your user, drives both the UI and outgoing notification emails, and falls back to your browser language for new accounts.
| Section | Purpose |
|---|---|
| Getting started | Deploy Testjam, create the first admin, sign in. |
| Projects | Create, archive, export projects. |
| Dashboard | Per-project landing view with metrics, recent runs, open bugs. |
| Suites & cases | Modelling the test library. |
| Plans | Curate versioned bundles of cases. |
| Executions | Manual and automatic runs, live view. |
| Bugs | Native bug tracker tied to executions and versions. |
| Mentions | @user, #bug, !run, ~case references with notifications. |
| Versions, environments & coverage | Per-project release + target organisation. |
| Custom fields | Extend bugs, cases, executions with structured fields. |
| Notifications | In-app bell, email, WebSocket push, per-user preferences. |
| Public reports | Tokenised read-only shares of bugs and executions. |
| External linking | Jira / GitHub / GitLab / Azure DevOps / OpenProject. |
| Outgoing webhooks | HMAC-signed events pushed to external systems. |
| Import & export | JUnit, Robot Framework, HTML/PDF/XLSX, project ZIP. |
| Robot listener | Stream results from your CI. |
| Python SDK | testjam-client setup, auth, resource modules, CI examples. |
testjam CLI |
Interactive shell + scriptable commands against the API. |
| Members & API tokens | Roles, permissions, X-API-Key. |
| Groups | Bundle users for project access by group. |
| Appearance | Dark mode + UI language per user. |
| Administration | Global users, instance settings, backups. |
| Keyboard shortcuts | Full table of bindings. |
| Section | Summary |
|---|---|
| Docker runner | Run automatic tests without an external CI. |
| Multi-tenant | Organizations as a layer above projects. |
Images used by this manual live in screenshots/. If a capture becomes outdated after a UI change, regenerate the set following the README inside that folder.