Skip to content

docs: english-only public docs and reposition around the source paper#225

Merged
caitlon merged 6 commits into
developfrom
docs/english-only-repo
Jun 4, 2026
Merged

docs: english-only public docs and reposition around the source paper#225
caitlon merged 6 commits into
developfrom
docs/english-only-repo

Conversation

@caitlon

@caitlon caitlon commented Jun 4, 2026

Copy link
Copy Markdown
Owner

Greptile Summary

This PR consolidates the public documentation to English-only, repositions the project around the original Vrana et al. (2021) source paper, and flattens the language-subdirectory structure (en/, cs/) across examples, data files, and UML diagrams.

  • The per-language example scripts under examples/en/ and examples/cs/ are deleted; their content is inlined into the top-level examples/analyze_*.py wrappers, and data files are promoted from examples/data/en/ to examples/data/.
  • Czech localization artifacts are gitignored so they can be maintained locally without being published; UML diagram generation is updated to match the new directory layout.
  • Frontend i18n keys drop the thesis-specific branding in both en and cs locales, keeping the locales parallel.

Confidence Score: 4/5

Safe to merge; the structural changes are consistent and the data files exist at the new paths.

All path consolidations are correct — data files land at examples/data/ and tests confirm that. The only carry-over is the non-ASCII Δ character that was already present in the now-deleted examples/en/ files and has been inlined into the three top-level example scripts without remediation.

examples/analyze_budget_case.py, examples/analyze_floods_case.py, examples/analyze_pendlers_case.py — each contains a Δ character in a print statement that violates the ASCII-only rule.

Important Files Changed

Filename Overview
README.md Repositions the project description around the source paper (Vrana et al. 2021), removes thesis metadata, updates all UML diagram links from en/ to the new top-level path. No issues.
examples/analyze_budget_case.py Inlined content from deleted examples/en/analyze_budget_case.py; non-ASCII Δ character carried over into the print statement at line 48 (py-ascii-only violation).
examples/analyze_floods_case.py Inlined content from deleted examples/en/analyze_floods_case.py; same non-ASCII Δ character at line 51.
examples/analyze_pendlers_case.py Inlined content from deleted examples/en/analyze_pendlers_case.py; same non-ASCII Δ character at line 70.
tests/unit/utilities/test_runner.py Data-file paths updated from DATA_DIR / "en" / ... to DATA_DIR / ...; files exist at the new location. TestRunAnalysisWithCzech now loads English data with Czech labels — structurally correct since numeric values are identical.
docs/uml-diagrams/generate_diagrams.py Replaces the language-list loop with a lang_roots dict; English diagrams now live at the top-level directory, Czech diagrams in cs/ (gitignored). Logic is correct and skips the CS path gracefully when absent.
frontend/src/i18n/locales/en/common.json Updates implementationAuthor and implementationThesis keys to drop thesis branding; matching keys updated in locales/cs/common.json — i18n-parallel-locales rule satisfied.
.gitignore Adds gitignore entries for Czech localization artifacts (docs/uml-diagrams/cs/, examples/cs/, examples/data/cs/, examples/visualizations/cs/) to keep them local-only. Correct.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[examples/analyze_budget_case.py\nanalyze_floods_case.py\nanalyze_pendlers_case.py] -->|reads| B[examples/data/budget_case.txt\nfloods_case.txt\npendlers_case.txt]
    A -->|uses| C[examples/utils/runner.run_analysis]
    C -->|invokes| D[BeCoMeCalculator]
    D -->|arithmetic mean| E[FuzzyTriangleNumber - Gamma]
    D -->|median| F[FuzzyTriangleNumber - Omega]
    E & F -->|component-wise avg| G[best_compromise]
    G --> H[AnalysisResult frozen dataclass]
    H --> I[print interpretation + delta_max]

    subgraph deleted
        X[examples/en/analyze_*.py]
        Y[examples/cs/analyze_*.py]
        Z[examples/data/en/*.txt]
        W[examples/data/cs/*.txt]
    end
Loading
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
examples/analyze_budget_case.py:48
The `Δ` (U+0394) character violates the `py-ascii-only` rule, which requires all code, comments, and string literals to use only ASCII. The same character appears at `examples/analyze_floods_case.py:51` and `examples/analyze_pendlers_case.py:70`. Replace each with the spelled-out ASCII token `delta_max`.

```suggestion
    print(f"Precision indicator (delta_max): {ar.max_error:.2f}")
```

Reviews (1): Last reviewed commit: "test: load runner case data from flatten..." | Re-trigger Greptile

@caitlon caitlon added this to the v1.1-polish milestone Jun 4, 2026
@caitlon caitlon added type:tech-debt Code quality improvement type:docs Documentation area:infra CI/CD, Docker area:i18n Internationalization labels Jun 4, 2026
@caitlon caitlon self-assigned this Jun 4, 2026
@sonarqubecloud

sonarqubecloud Bot commented Jun 4, 2026

Copy link
Copy Markdown

@caitlon caitlon merged commit 19ddcf7 into develop Jun 4, 2026
8 checks passed
@caitlon caitlon deleted the docs/english-only-repo branch June 4, 2026 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:i18n Internationalization area:infra CI/CD, Docker type:docs Documentation type:tech-debt Code quality improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant