From 265ad8d10323f8a66874eecec4579dfb65361c4e Mon Sep 17 00:00:00 2001 From: Anton Melser Date: Wed, 10 Dec 2025 13:57:31 +0800 Subject: [PATCH 1/4] docs: Generify currently supported node version --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 136fee6b..097af050 100644 --- a/README.rst +++ b/README.rst @@ -23,9 +23,9 @@ Cloning and Startup git clone https://github.com/edx/frontend-app-communications.git -2. Use node v18.x. +2. Use the version of Node specified in the ``.nvmrc`` file. - The current version of the micro-frontend build scripts supports node 18. + The current version of the micro-frontend build scripts supports the version of Node found in ``.nvmrc``. Using other major versions of node *may* work, but this is unsupported. For convenience, this repository includes a ``.nvmrc`` file to help in setting the correct node version via `nvm `_. From 188413cc5e40c2b3c6f00d90ab9fe4799bad0bab Mon Sep 17 00:00:00 2001 From: Anton Melser Date: Wed, 10 Dec 2025 14:00:07 +0800 Subject: [PATCH 2/4] docs: include 'standard' dev instructions --- README.rst | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 097af050..71ff8716 100644 --- a/README.rst +++ b/README.rst @@ -4,15 +4,27 @@ frontend-app-communications |license-badge| |status-badge| |ci-badge| |codecov-badge| +******** Purpose -******* +******** A tool used by course teams to communicate with their learners. The interface for anything related to instructor-to-learner communications. Instructor bulk email, for example. -Getting started ---------------- +*************** +Getting Started +*************** + +Prerequisites +============= + +`Tutor`_ is currently recommended as a development environment for your +new MFE. Please refer +to the `relevant tutor-mfe documentation`_ to get started using it. + +.. _Tutor: https://github.com/overhangio/tutor + +.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development -For now, this repo is not integrated with devstack. You'll be running the app locally and not through docker. This does make setup a little easier. Cloning and Startup =================== From ad98b92ba444182110cc01a837bbac4bf376d392 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Fri, 23 Jan 2026 10:33:55 -0500 Subject: [PATCH 3/4] temp: Apply suggestion from @feanil --- README.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/README.rst b/README.rst index 71ff8716..95ff31b0 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,6 @@ frontend-app-communications |license-badge| |status-badge| |ci-badge| |codecov-badge| -******** Purpose ******** From bf6bdf88d8f1b15552f8c2d30597515b7816ea6f Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Fri, 23 Jan 2026 12:22:59 -0500 Subject: [PATCH 4/4] temp: Update README.rst --- README.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/README.rst b/README.rst index 95ff31b0..be79850d 100644 --- a/README.rst +++ b/README.rst @@ -9,7 +9,6 @@ Purpose A tool used by course teams to communicate with their learners. The interface for anything related to instructor-to-learner communications. Instructor bulk email, for example. -*************** Getting Started ***************