Merge pull request #15598 from edx/andya/developer-doc-cleanups

Improve documentation for the Open edX features

openedx/features/course_bookmarks/README.rst

@@ -0,0 +1,9 @@
+Course Bookmarks
+----------------
+
+This directory contains a Django application that provides a page
+for a user to see all of their course bookmarks. It also registers
+a course tool called "Bookmarks" that provides a link to this page.
+For more information about the feature, see `Bookmarking Course Content`_.
+
+.. _Bookmarking Course Content: https://edx.readthedocs.io/projects/open-edx-learner-guide/en/latest/SFD_bookmarks.html

openedx/features/course_experience/README.rst

@@ -0,0 +1,56 @@
+Course Experience
+-----------------
+
+This directory contains a Django application that provides the Course Home page
+(or course landing page), and various resources in support of the landing
+experience.
+
+The course experience consists of a number of views:
+
+1. **Course Home**
+
+   The course home page is the landing page for the course. It presents
+   the learner with information necessary to understand the purpose of the
+   course, its content, and its milestones. It includes a "Course Tools"
+   section that provides links to other tools associated with the course.
+   For example, it includes tools such as reviews, updates and bookmarks.
+
+2. **Welcome Message**
+
+   The welcome message is a fragment view which is typically shown on the
+   course home page. It provides the user with a description of the course
+   and helps them to understand its requirements.
+
+3. **Course Outline**
+
+   The course outline is a fragment view which shows an outline of the content
+   of the course.
+
+4. **Course Dates**
+
+   The course dates fragment is a view which shows users important dates for the
+   course, such as the start and end dates.
+
+5. **Course Sock**
+
+   The course sock is a fragment view which is typically shown just above
+   the footer of course pages (hence the name). The default implementation
+   presents the users with a message encouraging them to purchase a verified
+   certificate.
+
+6. **Course Updates**
+
+   The course updates page shows the user all of the course team's updates
+   in a scrolling list. The updates page is also provided as a course tool.
+
+7. **Course Reviews**
+
+   This page shows the user reviews of the course from an external provider.
+   The default provider is `CourseTalk`_. The reviews page is also provided
+   as a course tool.
+
+A number of the features in the course experience are controlled via Waffle
+flags. For documentation, see `Waffle flag definitions`_.
+
+.. _CourseTalk: https://www.coursetalk.com/
+.. _Waffle flag definitions: https://github.com/edx/edx-platform/blob/master/openedx/features/course_experience/__init__.py

openedx/features/course_search/README.rst

@@ -0,0 +1,7 @@
+Course Search
+-------------
+
+This directory contains a Django application that allows a learner to search
+the content of their course. To learn more, see `Enabling Open edX Search`_.
+
+.. _Enabling Open edX Search: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/edx_search.html

openedx/features/coursetalk/README.rst

@@ -0,0 +1,7 @@
+CourseTalk
+----------
+
+This directory contains a Django application that integrates `CourseTalk`_
+as a course review provider for Open edX.
+
+.. _CourseTalk: https://www.coursetalk.com/

openedx/features/learner_profile/README.rst

@@ -0,0 +1,8 @@
+Learner Profile
+---------------
+
+This directory contains a Django application that provides a view to render
+a profile for any Open edX learner. See `Exploring Your Dashboard and Profile`_
+for more details.
+
+.. _Exploring Your Dashboard and Profile: https://edx.readthedocs.io/projects/open-edx-learner-guide/en/latest/SFD_dashboard_profile_SectionHead.html?highlight=profile