Skip to content

docs: updates for outdated references #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feanil merged 4 commits into from
Jan 23, 2026
Merged

docs: updates for outdated references #262

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
265ad8d
docs: Generify currently supported node version
AntonOfTheWoods Dec 10, 2025
188413c
docs: include 'standard' dev instructions
AntonOfTheWoods Dec 10, 2025
ad98b92
temp: Apply suggestion from @feanil
feanil Jan 23, 2026
bf6bdf8
temp: Update README.rst
feanil Jan 23, 2026
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
22 changes: 16 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,24 @@ frontend-app-communications


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
===================
Expand All @@ -23,9 +33,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 <https://github.com/nvm-sh/nvm>`_.
Expand Down