Skip to content

Improve Installation Documentation and Avoid sudo Usage #18

@sujalsalekar

Description

@sujalsalekar

Improve Installation Documentation and Remove sudo Recommendation

  • Issue: The current README shows a failed installation attempt followed by using sudo as a workaround.
  • Impact: Using sudo for package installation is not a best practice and can lead to permission issues or unintended consequences.
  • Suggestion: Update the documentation with proper installation steps, including prerequisite setup and troubleshooting guidance, without relying on sudo.

Improve Test Coverage and Document Testing Strategy

  • Issue: While the repository displays a Codecov badge, the overall test coverage appears insufficient.
  • Impact: Without comprehensive tests, especially unit and edge-case coverage, regressions can easily occur.
  • Suggestion: Increase test coverage across modules, add unit tests where missing, and provide a documented strategy for how tests should be structured and maintained.

Add Workshop Progress Tracking Feature

  • Issue: There's no system in place to track a user's progress through the workshop.
  • Impact: This makes it difficult for participants to resume where they left off or measure their completion status.
  • Suggestion: Introduce a progress tracking mechanism—this could be as simple as localStorage tracking, checkboxes, or a more advanced progress bar feature integrated into the UI.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions