Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Deploy Docs

on:
push:
branches:
- develop

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build-and-deploy:
name: Build & Deploy Docs
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install docs dependencies
working-directory: docs-site
run: pnpm install --ignore-workspace --frozen-lockfile

- name: Build docs site
working-directory: docs-site
run: pnpm build

- name: Setup Pages
uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs-site/build

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ dist

# Docusaurus cache and generated files
.docusaurus
docs-site/build/

# Serverless directories
.serverless/
Expand Down Expand Up @@ -157,3 +158,5 @@ vitest.config.*.timestamp*
.worktrees/
/apps/tracker/src/i18n-types/tracker-resources.ts
/sample-translations/mock-design-system/
/.playwright-cli/
/.playwright/
42 changes: 37 additions & 5 deletions .lingo-tracker.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,52 @@
"exportFolder": "dist/lingo-export",
"importFolder": "dist/lingo-import",
"baseLocale": "en",
"locales": ["en", "fr-ca", "es", "de", "ja"],
"locales": [
"en",
"fr-ca",
"es",
"ru",
"de",
"ja"
],
"collections": {
"TestDataPlayground": {
"translationsFolder": "sample-translations/playground",
"locales": ["en", "fr-ca", "es", "de", "ja"]
"locales": [
"en",
"fr-ca",
"es",
"de",
"ja"
]
},
"trackerResources": {
"translationsFolder": "apps/tracker/src/i18n",
"locales": ["en", "es", "fr-ca"]
"locales": [
"en",
"es",
"fr-ca",
"ru",
"ja",
"de"
]
},
"mockDesignSystem": {
"translationsFolder": "sample-translations/mock-design-system",
"importFolder": "dist/ds-translations",
"locales": ["ar", "de", "es", "fr-ca", "fr-fr", "is", "ja", "ko", "nl", "pt-br", "sv"]
"locales": [
"ar",
"de",
"es",
"fr-ca",
"fr-fr",
"is",
"ja",
"ko",
"nl",
"pt-br",
"sv"
]
}
},
"translation": {
Expand All @@ -42,4 +74,4 @@
"typeDistFile": "./apps/tracker/src/i18n-types/tracker-resources.ts"
}
}
}
}
8 changes: 7 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ libs/

### Application Responsibilities

- **CLI** (`apps/cli`): Commands for init, add-collection, delete-collection, add-resource. Supports both interactive (TTY) and non-interactive (CI/CD) modes.
- **CLI** (`apps/cli`): Commands for init, add-collection, delete-collection, add-resource, edit-resource, delete-resource, move, normalize, bundle, export, import, validate, find-similar, install-skill. Supports both interactive (TTY) and non-interactive (CI/CD) modes.
- **API** (`apps/api`): REST endpoints at `/api/*`, serves static Tracker UI, uses mappers to convert between core domain models and DTOs.
- **Tracker UI** (`apps/tracker`): Angular app with Material UI for browsing/managing translations, uses NgRx Signals for state management.

Expand Down Expand Up @@ -154,6 +154,12 @@ export class ExampleComponent implements OnInit {
}
```

### TypeScript Safety

- **No non-null assertions**: Never use the `!` operator. The linter (`lint/style/noNonNullAssertion`) forbids it.
- In production code: use an explicit null-guard (`if (!x) return;` or `if (!x) throw`) before accessing the value
- In tests: use `expect(value).toBeDefined()` followed by optional chaining (`value?.property`) for subsequent assertions

### Code Organization

- **Domain Logic** (`@simoncodes-ca/domain`): Pure business logic with **zero Node.js dependencies** — importable by all apps including the browser-based Tracker UI. This is where platform-agnostic logic belongs: key validation/parsing, translation status helpers, ICU↔Transloco format conversion, validation utilities (locale, key length, duplicates, hierarchical conflicts), and shared types (`TranslationStatus`, `LocaleMetadata`).
Expand Down
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,16 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org/).
- **DTOs**: API contracts are defined in `libs/data-transfer`.
- **Testing**: Vitest for unit tests.

## Contributing to Documentation

The docs site lives in `docs-site/` and is built with [Docusaurus](https://docusaurus.io/). To run it locally:

```bash
pnpm run docs:dev
```

Documentation source files are located under `docs-site/src/pages/`. Add or edit pages there and open a pull request as you would for any other change.

## Questions?

Open an [issue](https://github.com/simoncodes-ca/lingo-tracker/issues) and we'll be happy to help.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ npx lingo-tracker validate
npx lingo-tracker-app
```

Check the [getting started guide](docs/getting-started.md) for detailed setup instructions, or the full [CLI reference](docs/cli.md) for all available commands.
Check the [documentation site](https://simoncodes-ca.github.io/lingo-tracker/), the [getting started guide](docs/getting-started.md) for detailed setup instructions, or the full [CLI reference](docs/cli.md) for all available commands.

## Roadmap

Expand Down
80 changes: 0 additions & 80 deletions ai/diagrams/apps.md

This file was deleted.

Loading
Loading