Skip to content

Add multilang examples and CI check; expand README (CI/CD, preview) - #8

Merged
nesvet merged 2 commits into
mainfrom
docs/multilang-examples
Feb 8, 2026
Merged

Add multilang examples and CI check; expand README (CI/CD, preview)#8
nesvet merged 2 commits into
mainfrom
docs/multilang-examples

Conversation

@nesvet

@nesvet nesvet commented Feb 8, 2026

Copy link
Copy Markdown
Owner

Description

Closes #6

What does this PR do?

Adds minimal sample projects in TypeScript, Python, Java, Go, and Rust under examples/, each with a generated fln snapshot (examples/*.md), and ensures those snapshots stay in sync in CI. Expands the README with a language-agnostic pitch, a CI/CD & Automation section (GitHub Actions snapshot workflow, pre-commit context guard), and a Preview section that links to the real example outputs instead of inline placeholders.

Changes

  • Add examples/ with ts-app, python-app, java-app, go-app, rust-app (source + generated *.md snapshots)
  • Add scripts/generate-examples.ts and bun run generate:examples to regenerate examples/*.md
  • CI: new step “Examples up-to-date” (run generate:examples, then git diff --exit-code -- "examples/*.md")
  • README: language-agnostic intro, bullet punctuation, “Auditable Snapshots” and “Dataset Preparation”, CI/CD subsection (Actions + pre-commit), Preview links to examples/*.md
  • Add examples/README.md describing the layout and regeneration

Testing

  • bun test passes
  • bun run lint passes
  • bun run typecheck passes

Checklist

  • Updated documentation if needed (README, CONTRIBUTING, etc.)
  • Added tests for new features or bug fixes
  • Checked that the change doesn't break existing functionality

- Add sample projects: ts-app, python-app, java-app, go-app, rust-app
- Add scripts/generate-examples.ts to produce examples/*.md from source
- CI: verify examples/*.md are up-to-date after generate:examples
- README: add CI/CD & Automation section, --generated-date option, link previews to examples
- Move generate-version.ts to scripts/generate-version.ts
@nesvet
nesvet merged commit c7635fc into main Feb 8, 2026
1 check passed
@nesvet
nesvet deleted the docs/multilang-examples branch February 8, 2026 23:07
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.

[Feature]: README improvement: Clarify multi-language support + add self-generated output example

1 participant