From 3a3af13c54b8d3bfce8610fceaf7d9b8395a27ba Mon Sep 17 00:00:00 2001 From: "Edward A. Lee" Date: Mon, 17 Aug 2026 10:50:58 -0700 Subject: [PATCH 1/2] Added developer documentation page and removed eclipse page --- docs/developer/documentation.mdx | 59 +++++++++++++++++++++ docs/developer/downloading-and-building.mdx | 7 +-- docs/sidebars.ts | 2 +- 3 files changed, 64 insertions(+), 4 deletions(-) create mode 100644 docs/developer/documentation.mdx diff --git a/docs/developer/documentation.mdx b/docs/developer/documentation.mdx new file mode 100644 index 000000000..f5a2e2140 --- /dev/null +++ b/docs/developer/documentation.mdx @@ -0,0 +1,59 @@ +--- +title: Documentation +description: Pointers to Lingua Franca documentation, source repositories, examples, and templates. +--- + +This page collects pointers to Lingua Franca documentation, source repositories, examples, and templates. + +## User Documentation + +- [Lingua Franca user documentation](https://lf-lang.org) +- [micro-LF user documentation](https://micro-lf.org) + +## Code Documentation + +- [lingua-franca code generator](https://lf-lang.org/lingua-franca) +- [reactor-c runtime system](https://lf-lang.org/reactor-c) +- [reactor-uc runtime system](https://dev.micro-lf.org) (used by micro-LF) + +## Main GitHub Repositories + +- [lingua-franca](https://github.com/lf-lang/lingua-franca): code generator +- [vscode-lingua-franca](https://github.com/lf-lang/vscode-lingua-franca): Visual Studio Code extension +- [reactor-c](https://github.com/lf-lang/reactor-c): runtime system for the C target +- [reactor-uc](https://github.com/lf-lang/reactor-uc): runtime system for micro-LF +- [lf-python-support](https://github.com/lf-lang/lf-python-support): runtime support for the Python target +- [reactor-cpp](https://github.com/lf-lang/reactor-cpp): runtime system for C++ +- [reactor-ts](https://github.com/lf-lang/reactor-ts): runtime system for the TypeScript target +- [reactor-rs](https://github.com/lf-lang/reactor-rs): runtime system for the Rust target +- [release-tools](https://github.com/lf-lang/release-tools): release tools + +## GitHub Repositories with Examples + +- [playground-lingua-franca](https://github.com/lf-lang/playground-lingua-franca): Collection of Lingua Franca examples +- [curated-c](https://github.com/lf-lang/curated-c): context for AI-assisted design in the C target +- [curated-py](https://github.com/lf-lang/curated-py): context for AI-assisted design in the Python target +- [pkgs](https://github.com/lf-lang/pkgs): main packages directory, with pointers to packages +- [lf-demos](https://github.com/lf-lang/lf-demos): demo programs from talks and tutorials + +## GitHub Repositories for Web Pages + +- [lf-lang.github.io](https://github.com/lf-lang/lf-lang.github.io): lf-lang.org web page +- [micro-lf-documentation](https://github.com/lf-lang/micro-lf-documentation): micro-lf.org web page + +## Templates for Embedded Processors using the C Target + +- [lf-pico-template](https://github.com/lf-lang/lf-pico-template): Raspberry Pi Pico +- [lf-3pi-template](https://github.com/lf-lang/lf-3pi-template): Pololu 3-Pi robot +- [lf-west-template](https://github.com/lf-lang/lf-west-template): Zephyr development +- [lf-patmos-template](https://github.com/lf-lang/lf-patmos-template): Patmos processor + +## Templates for Embedded Processors using micro-LF + +- [ulf-posix-template](https://github.com/lf-lang/ulf-posix-template): micro-LF development on macOS or Linux +- [ulf-freertos-template](https://github.com/lf-lang/ulf-freertos-template): FreeRTOS +- [ulf-zephyr-template](https://github.com/lf-lang/ulf-zephyr-template): Zephyr +- [ulf-riot-template](https://github.com/lf-lang/ulf-riot-template): RIOT +- [ulf-esp-idf-template](https://github.com/lf-lang/ulf-esp-idf-template): ESP-IDF +- [ulf-patmos-template](https://github.com/lf-lang/ulf-patmos-template): Patmos processor +- [ulf-pico-template](https://github.com/lf-lang/ulf-pico-template): Raspberry Pi Pico diff --git a/docs/developer/downloading-and-building.mdx b/docs/developer/downloading-and-building.mdx index 6bf23afe1..666729855 100644 --- a/docs/developer/downloading-and-building.mdx +++ b/docs/developer/downloading-and-building.mdx @@ -47,9 +47,10 @@ Thus, you can choose if you want to use `bin/lfc-dev`, which first builds `lfc` ## IDE Integration You can use any editor or IDE that you like to work with the code base. -However, we would suggest to choose an IDE that comes with good Java (and -ideally Kotlin) support and that integrates well with Gradle. -We recommend to use our [IntelliJ setup](../developer/developer-intellij-setup.mdx). +However, we suggest choosing an IDE with good Java and +Kotlin support and that integrates well with Gradle. +[Visual Studio Code](https://code.visualstudio.com) and [Cursor](https://cursor.com/sdk) are both good choices, particularly because the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code provides a rich set of features for working with Lingua Franca code, including automatic diagram generation. +You can also use our [IntelliJ setup](../developer/developer-intellij-setup.mdx). ## Building the VS Code extension To build the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code, refer to the README in the source repository. diff --git a/docs/sidebars.ts b/docs/sidebars.ts index 5206c1098..df32ec6ed 100644 --- a/docs/sidebars.ts +++ b/docs/sidebars.ts @@ -222,7 +222,7 @@ const sidebars: SidebarsConfig = { }, { "type": "doc", - "id": "developer/developer-eclipse-setup-with-oomph" + "id": "developer/documentation" }, { "type": "doc", From fe967b31ee23c0096e284d585c0d48dcb4f36c20 Mon Sep 17 00:00:00 2001 From: "Edward A. Lee" Date: Mon, 17 Aug 2026 10:54:36 -0700 Subject: [PATCH 2/2] Added documentation page to 0.13.0 versioned docs --- .../developer/documentation.mdx | 59 +++++++++++++++++++ .../developer/downloading-and-building.mdx | 7 ++- .../version-0.13.0-sidebars.json | 2 +- 3 files changed, 64 insertions(+), 4 deletions(-) create mode 100644 versioned_docs/version-0.13.0/developer/documentation.mdx diff --git a/versioned_docs/version-0.13.0/developer/documentation.mdx b/versioned_docs/version-0.13.0/developer/documentation.mdx new file mode 100644 index 000000000..f5a2e2140 --- /dev/null +++ b/versioned_docs/version-0.13.0/developer/documentation.mdx @@ -0,0 +1,59 @@ +--- +title: Documentation +description: Pointers to Lingua Franca documentation, source repositories, examples, and templates. +--- + +This page collects pointers to Lingua Franca documentation, source repositories, examples, and templates. + +## User Documentation + +- [Lingua Franca user documentation](https://lf-lang.org) +- [micro-LF user documentation](https://micro-lf.org) + +## Code Documentation + +- [lingua-franca code generator](https://lf-lang.org/lingua-franca) +- [reactor-c runtime system](https://lf-lang.org/reactor-c) +- [reactor-uc runtime system](https://dev.micro-lf.org) (used by micro-LF) + +## Main GitHub Repositories + +- [lingua-franca](https://github.com/lf-lang/lingua-franca): code generator +- [vscode-lingua-franca](https://github.com/lf-lang/vscode-lingua-franca): Visual Studio Code extension +- [reactor-c](https://github.com/lf-lang/reactor-c): runtime system for the C target +- [reactor-uc](https://github.com/lf-lang/reactor-uc): runtime system for micro-LF +- [lf-python-support](https://github.com/lf-lang/lf-python-support): runtime support for the Python target +- [reactor-cpp](https://github.com/lf-lang/reactor-cpp): runtime system for C++ +- [reactor-ts](https://github.com/lf-lang/reactor-ts): runtime system for the TypeScript target +- [reactor-rs](https://github.com/lf-lang/reactor-rs): runtime system for the Rust target +- [release-tools](https://github.com/lf-lang/release-tools): release tools + +## GitHub Repositories with Examples + +- [playground-lingua-franca](https://github.com/lf-lang/playground-lingua-franca): Collection of Lingua Franca examples +- [curated-c](https://github.com/lf-lang/curated-c): context for AI-assisted design in the C target +- [curated-py](https://github.com/lf-lang/curated-py): context for AI-assisted design in the Python target +- [pkgs](https://github.com/lf-lang/pkgs): main packages directory, with pointers to packages +- [lf-demos](https://github.com/lf-lang/lf-demos): demo programs from talks and tutorials + +## GitHub Repositories for Web Pages + +- [lf-lang.github.io](https://github.com/lf-lang/lf-lang.github.io): lf-lang.org web page +- [micro-lf-documentation](https://github.com/lf-lang/micro-lf-documentation): micro-lf.org web page + +## Templates for Embedded Processors using the C Target + +- [lf-pico-template](https://github.com/lf-lang/lf-pico-template): Raspberry Pi Pico +- [lf-3pi-template](https://github.com/lf-lang/lf-3pi-template): Pololu 3-Pi robot +- [lf-west-template](https://github.com/lf-lang/lf-west-template): Zephyr development +- [lf-patmos-template](https://github.com/lf-lang/lf-patmos-template): Patmos processor + +## Templates for Embedded Processors using micro-LF + +- [ulf-posix-template](https://github.com/lf-lang/ulf-posix-template): micro-LF development on macOS or Linux +- [ulf-freertos-template](https://github.com/lf-lang/ulf-freertos-template): FreeRTOS +- [ulf-zephyr-template](https://github.com/lf-lang/ulf-zephyr-template): Zephyr +- [ulf-riot-template](https://github.com/lf-lang/ulf-riot-template): RIOT +- [ulf-esp-idf-template](https://github.com/lf-lang/ulf-esp-idf-template): ESP-IDF +- [ulf-patmos-template](https://github.com/lf-lang/ulf-patmos-template): Patmos processor +- [ulf-pico-template](https://github.com/lf-lang/ulf-pico-template): Raspberry Pi Pico diff --git a/versioned_docs/version-0.13.0/developer/downloading-and-building.mdx b/versioned_docs/version-0.13.0/developer/downloading-and-building.mdx index 6bf23afe1..666729855 100644 --- a/versioned_docs/version-0.13.0/developer/downloading-and-building.mdx +++ b/versioned_docs/version-0.13.0/developer/downloading-and-building.mdx @@ -47,9 +47,10 @@ Thus, you can choose if you want to use `bin/lfc-dev`, which first builds `lfc` ## IDE Integration You can use any editor or IDE that you like to work with the code base. -However, we would suggest to choose an IDE that comes with good Java (and -ideally Kotlin) support and that integrates well with Gradle. -We recommend to use our [IntelliJ setup](../developer/developer-intellij-setup.mdx). +However, we suggest choosing an IDE with good Java and +Kotlin support and that integrates well with Gradle. +[Visual Studio Code](https://code.visualstudio.com) and [Cursor](https://cursor.com/sdk) are both good choices, particularly because the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code provides a rich set of features for working with Lingua Franca code, including automatic diagram generation. +You can also use our [IntelliJ setup](../developer/developer-intellij-setup.mdx). ## Building the VS Code extension To build the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code, refer to the README in the source repository. diff --git a/versioned_sidebars/version-0.13.0-sidebars.json b/versioned_sidebars/version-0.13.0-sidebars.json index a640b4b36..3fca4a501 100644 --- a/versioned_sidebars/version-0.13.0-sidebars.json +++ b/versioned_sidebars/version-0.13.0-sidebars.json @@ -208,7 +208,7 @@ }, { "type": "doc", - "id": "developer/developer-eclipse-setup-with-oomph" + "id": "developer/documentation" }, { "type": "doc",