Merge pull request #212 from openedx/mashal-m/update-README

refactor: updated README file to reflect template changes

README.rst

@@ -1,9 +1,10 @@
+###########################
 frontend-app-learner-record
-#############################
-
+############################
 
 |Build Status| |Codecov| |license|
 
+********
 Purpose
 *******
 
@@ -19,14 +20,15 @@ This is the Learner Record micro-frontend, currently under development by `edX <
 
 .. _verifiable credentials: https://en.wikipedia.org/wiki/Verifiable_credentials
 
+***************
 Getting Started
 ***************
 
 Developing
 ==========
 
 One Time Setup
---------------
+==============
 .. code-block::
 
   # Clone the repository via SSH
@@ -44,7 +46,7 @@ One Time Setup
 The page will then be hosted on http://localhost:1990/
 
 Every time you develop something in this repo
----------------------------------------------
+=============================================
 .. code-block::
 
   # Grab the latest code
@@ -73,7 +75,7 @@ Every time you develop something in this repo
   # Open a PR and ask for review after the github CI has passed.
 
 Environment Variables/Setup Notes
----------------------------------
+=================================
 
 Currently, this MFE is not intergrated into the devstack, and must be run locally. This MFE requires credentials to be running, and will use a REST API from the Credentials IDA located at `credentials/apps/records/rest_api`.
 
@@ -100,7 +102,7 @@ The Verifiable Credentials UI is a functional addition to the corresponding back
 
 
 Project Structure
------------------
+==================
 
 The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization <https://github.com/edx/frontend-template-application/blob/master/docs/decisions/0002-feature-based-application-organization.rst>`_.
 
@@ -115,11 +117,8 @@ General deployment information can be found in the `Microfrontend onboarding`_ d
 
 .. _Microfrontend onboarding: https://openedx.atlassian.net/wiki/spaces/FEDX/pages/2629829454/Micro+Frontend+MFE+Onboarding#Deployment
 
-
 Getting Help
-************
-More Help
-=========
+============
 
 If you're having trouble, we have discussion forums at
 https://discuss.openedx.org where you can connect with others in the
@@ -141,15 +140,15 @@ For more information about these options, see the `Getting Help`_ page.
 .. _Getting Help: https://openedx.org/getting-help
 
 License
-*******
+=======
 
 The code in this repository is licensed under the `GNU AFFERO GENERAL PUBLIC LICENSE` unless
 otherwise noted.
 
 Please see `LICENSE.txt <LICENSE.txt>`_ for details.
 
 Contributing
-************
+============
 
 Contributions are very welcome.
 Please read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.
@@ -162,14 +161,13 @@ You can start a conversation by creating a new issue on this repo summarizing
 your idea.
 
 The Open edX Code of Conduct
-****************************
-
+============================
 All community members are expected to follow the `Open edX Code of Conduct`_.
 
 .. _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``
@@ -178,7 +176,7 @@ file in this repo.
 .. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/{{ cookiecutter.repo_name }}
 
 Reporting Security Issues
-*************************
+==========================
 
 Please do not report security issues in public. Please email [email protected].