Include comprehensive list real life usage

Open
#190 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

Start with the linked community survey and review the repository's existing documentation for the Filters framework. Done means documenting a comprehensive set of real-world implementations, including the eduNEXT examples mentioned in the issue; no file or test is named, so the documentation location and scope need to be established first.

Written by the indexing model from the issue text.

Description

documentation

Description

Some comments I've gathered from the community survey on the challenges/suggestions section:

It was hard at first to get my head around the possibilities that the Filters framework offers -- because the possibilities are basically endless. It helped to see some of the custom filters that eduNEXT has built.

Maybe if the docs linked to as many different kinds of implementations as possible, that would help uptake?

Dominant language
Python
Stars
10
Forks
30
Avg merge
5h 49m
Merged PRs (30d)
5

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openedx/openedx-filters

All issues in openedx/openedx-filters

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.