Skip to content

Planet Manual Improvement: Clarify status and remove descriptive text for "Exams" and "Meetups" #3697

@uj-sxn

Description

@uj-sxn

Please verify the following:

URL to the MDwiki page containing the problem

https://open-learning-exchange.github.io/#!pages/manual/planet/overview.md

Problem

This issue is about improving the accuracy and clarity of the Planet User Manual by removing misleading information for features that are not fully functional.

Location of Problem:
The feature descriptions for Exams (Section 7/9) and Meetups (Section 8/9) in the Planet Learning overview manual.

Problem Details (Misleading Descriptions):
The manual currently provides detailed feature descriptions for two components that are marked as incomplete, which sets incorrect expectations for the user:

  1. Exams Feature: The manual states, "This portion is under development," but then follows with a parenthetical list of functions the feature may allow.
  2. Meetups Feature: The manual states, "This feature is unmaintained," but immediately follows this with a full bulleted list of functions the user can perform (Create meetups, Join existing meetups, etc.).

Screenshots (when necessary)

Location where the correction is needed:

  1. Image
  2. Image

Proposed solution(s)

Proposed Solution:
Simplify and reduce the descriptive text for both features to align the documentation with the features' current status:

  1. For Exams: Remove the parenthetical sentence describing the potential functions.
  2. For Meetups: Remove the entire bulleted list describing the functions.

This ensures the Planet User Manual is accurate and prevents users from wasting time trying to use broken or unmaintained features.

Metadata

Metadata

Assignees

No one assigned

    Labels

    vifirst steps - software engineering virtual intern

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions