docs: Update READMEs

Update both the repository's README.rst and the template to reflect the
current requirements as per [OEP-55](https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055/decisions/0003-readme-specification.html).

Author: Adolfo R. Brandes

README-template-frontend-app.rst

@@ -1,75 +1,259 @@
-|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release| ## As many of these as you'd like to include, or others if you wish!
+frontend-app-[PLACEHOLDER]
+##########################
 
-frontend-app-[YOUR NAME HERE]
-==============================
+.. note::
 
-Please tag **@edx/[YOUR-TEAM]** on any PRs or issues.  Thanks!
+  This README is a template.  As a maintainer, please review its contents and
+  update all relevant sections. Instructions to you are marked with
+  "[PLACEHOLDER]" or "[TODO]". Update or remove those sections, and remove this
+  note when you are done.
 
-Introduction
-------------
+|license-badge| |status-badge| |ci-badge| |codecov-badge|
 
-*What is this MFE? Add a 2-3 sentence description of what it is and what it does.*
+.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-[PLACEHOLDER].svg
+    :target: https://github.com/openedx/frontend-app-[PLACEHOLDER]/blob/main/LICENSE
+    :alt: License
 
-*What is the _domain_ of this MFE? That is, what is in here, what belongs here? What's*
-*_not_ in here that people might think could belong here, but is purposefully excluded?*
+.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
 
-*Add any additional detail/notes relevant to understanding the whats/whys of this*
-*MFE: could be links to publically available wikis/documents.*
+.. |ci-badge| image:: https://github.com/openedx/frontend-app-[PLACEHOLDER]/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/openedx/frontend-app-[PLACEHOLDER]/actions/workflows/ci.yml
+    :alt: Continuous Integration
 
-Installation
-------------
+.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-[PLACEHOLDER]/coverage.svg?branch=main
+    :target: https://codecov.io/github/openedx/frontend-app[PLACEHOLDER]?branch=main
+    :alt: Codecov
 
-This MFE is bundled with `Devstack <https://github.com/openedx/devstack>`_, see the `Getting Started <https://github.com/openedx/devstack#getting-started>`_ section for setup instructions.
+Purpose
+=======
 
-1. Enumerated list of steps & code blocks, like this:
+.. note::
+
+   [TODO]
+
+   What is this MFE?  Add a 2-3 sentence description of what it is and what it
+   does.
+
+This is the Awesome MFE.  It was built to provide an unmatched learning
+experience, with improved tools for both randomized goodness and the ability to
+directly reference amaze-blocks in existing courses. This experience is powered
+by the new Fantastico storage engine.
+
+Getting Started
+===============
+
+Devstack Installation
+---------------------
+
+.. note::
+
+   [TODO]
+
+   Describe in detail how this MFE can be installed and set up for development
+   in a devstack.  Include as many screenshots as you can to make your guide
+   easier to follow!  Use the following steps as an example:
+
+Follow these steps to provision, run, and enable an instance of the
+[PLACEHOLDER] MFE for local development via the `devstack`_.
+
+.. _devstack: https://github.com/openedx/devstack#getting-started
+
+#. To start, clone the devstack repository as a child of an arbitrary ``~/workspace/`` directory.
 
    .. code-block::
 
       mkdir -p ~/workspace/
       cd ~/workspace/
       git clone https://github.com/openedx/devstack.git
 
-2. Include as many screenshots as you can, to make your guide easier to follow! Include images with the following syntax:
+#. Configure default services and setup devstack
+
+   Create a ``devstack/options.local.mk`` file with only the services required.
+   Commonly, this will just be the LMS:
+
+   .. code-block::
+
+      DEFAULT_SERVICES ?= \
+      lms
+
+#. Start the devstack with:
+
+   .. code-block::
+
+      cd devstack
+      make dev.pull
+      make dev.provision
+      make dev.up
+
+#. In an LMS shell, enable the ``ENABLE_[PLACEHOLDER]_MICROFRONTEND`` feature flag:
+
+   .. code-block::
+
+      make lms-shell
+      vim /edx/etc/lms.yml
+      ---
+      FEATURES:
+          ENABLE_[PLACEHOLDER]_MICROFRONTEND: true
+
+   Exit the shell and restart the LMS so changes take effect:
+
+   .. code-block::
+
+      make lms-restart
+
+#. Create and enable the waffle flag required to redirect users to the MFE,
+   enabling it for everyone:
+
+   .. code-block::
+
+      make lms-shell
+      ./manage.py lms waffle_flag --create --everyone [PLACEHOLDER].redirect_to_microfrontend
+
+#. Start this MFE with:
+
+   .. code-block::
+
+      cd frontend-app-[PLACEHOLDER]
+      nvm use
+      npm ci
+      npm start
 
+#. Finally, open the MFE in a browser
 
-   .. image:: ./docs/images/example_image.png
+   Navigate to `http://localhost:8080 <http://localhost:8080>`_ to open the
+   MFE.  This is what it should look like if everything worked:
 
-Environment Variables/Setup Notes
----------------------------------
+   .. figure:: ./docs/images/template.jpg
 
-*Does this MFE rely on other MFEs, or LMS/Studio? Does it require use of specific APIs? Do certain settings*
-*need to be enabled?*
+      "Polycon marking template" by mangtronix is licensed under CC BY-SA 2.0.
 
-Any Other Relevant Sections
----------------------------
+Configuration
+-------------
 
-*This is optional, but you might have additional sections you wish to cover such as i18n notes, build process*
-*notes, stuff about ADRs, stuff about architecture, or more.*
+.. note::
+
+   [TODO]
+
+   Explicitly list anything that this MFE requires to function correctly.  This includes:
+
+   * A list of both required and optional .env variables, and how they each
+     affect the functioning of the MFE
+
+   * A list of edx-platform `feature and waffle flags`_ that are either required
+     to enable use of this MFE, or affect the behavior of the MFE in some other
+     way
+
+   * A list of IDAs or other MFEs that this MFE depends on to function correctly
+
+.. _feature and waffle flags: https://docs.openedx.org/projects/openedx-proposals/en/latest/best-practices/oep-0017-bp-feature-toggles.html
+
+[PLACEHOLDER: Other Relevant Sections]
+======================================
+
+.. note::
+
+   [TODO]
+
+   This is optional, but you might have additional sections you wish to cover.
+   For instance, architecture documentation, i18n notes, build process, or
+   more.
 
 Known Issues
-------------
+============
+
+.. note::
 
-* A bulleted list of issues, ideally with JIRA ticket numbers attached
+   [TODO]
 
-* OR - a link to a publically available wiki/document
+   If there are long-standing known issues, list them here as a bulletted list,
+   linking to the actual issues in the Github repository.
 
 Development Roadmap
--------------------
+===================
+
+.. note::
+
+   [TODO]
+
+   Include a list of current development targets, in (rough) descending order
+   of priority.  It can be a simple bulleted list of roadmap items with links
+   to Github issues or wiki pages.
+
+Getting Help
+============
+
+.. note::
+
+   [TODO]
+
+   Use the following as a template, but feel free to add specific places where
+   this MFE is commonly discussed.
+
+If you're having trouble, we have discussion forums at
+https://discuss.openedx.org where you can connect with others in the community.
+
+Our real-time conversations are on Slack. You can request a `Slack
+invitation`_, then join our `community Slack workspace`_.  Because this is a
+frontend repository, the best place to discuss it would be in the `#wg-frontend
+channel`_.
+
+For anything non-trivial, the best path is to open an issue in this repository
+with as many details about the issue you are facing as you can provide.
+
+https://github.com/openedx/frontend-app-[PLACEHOLDER]/issues
+
+For more information about these options, see the `Getting Help`_ page.
+
+.. _Slack invitation: https://openedx.org/slack
+.. _community Slack workspace: https://openedx.slack.com/
+.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6
+.. _Getting Help: https://openedx.org/getting-help
+
+License
+=======
+
+The code in this repository is licensed under the AGPLv3 unless otherwise
+noted.
+
+Please see `LICENSE <LICENSE>`_ for details.
+
+Contributing
+============
+
+.. note::
+
+   [TODO]
+
+   Feel free to add contribution details specific to your repository.
+
+Contributions are very welcome.  Please read `How To Contribute`_ for details.
+
+.. _How To Contribute: https://openedx.org/r/how-to-contribute
+
+This project is currently accepting all types of contributions, bug fixes,
+security fixes, maintenance work, or new features.  However, please make sure
+to have a discussion about your new feature idea with the maintainers prior to
+beginning development to maximize the chances of your change being accepted.
+You can start a conversation by creating a new issue on this repo summarizing
+your idea.
 
-The following is a list of current short-term development targets, in (rough) descending order of priority:
+The Open edX Code of Conduct
+============================
 
-* A bulleted list of roadmap items, ideally with JIRA ticket numbers attached (but could just be
-  a high-level overview of upcoming features/epics)
+All community members are expected to follow the `Open edX Code of Conduct`_.
 
-* OR - a link to a publically available wiki/document
+.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
 
+People
+======
 
-==============================
+The assigned maintainers for this component and other project details may be
+found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
+file in this repo.
 
-References (for authors of the README; delete this section before publishing)
+.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/frontend-app-[PLACEHOLDER]
 
-* https://github.com/openedx/frontend-app-library-authoring/blob/master/README.rst has many of the above discussed
-  sections and implements them well
+Reporting Security Issues
+=========================
 
-* https://opencraft.com/blog/introducing-open-edx-publisher/#how-does-it-work is an example of explaining when
-  env variables/settings are required
+Please do not report security issues in public.  Email [email protected] instead.