openedx / openedx/openedx-ai-extensions

User-facing documentation on what is possible

Open
#246 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
17
Forks
11
Avg merge
5h 33m
Merged PRs (30d)
4

Description

It'd be great to have some user-facing documentation about all that this plugin natively enabled. For example, the release notes for verawood are good, https://docs.openedx.org/en/latest/community/release_notes/verawood/ai_extension_framework.html#ai-extensions-framework-verawood, but don't mention flash cards. It'd be great to replicate this documentation, and further add to it, on the front page of the AI Extensions documentation book here: https://docs.openedx.org/projects/openedx-ai-extensions/en/latest/index.html

Right now, that's solely a developer resource. We should think harder about how to make documentation "sell" what we are providing, not just how to enable it; the why should you use this product is just as, if not more, important than how to install it.

@felipemontoya does this make sense to you? And do you have screenshots we could use around the flashcards?

Contributor guide

Open the contributing guide

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.

Research direction

Start with the AI Extensions documentation front page and the linked Verawood release notes, then inventory the plugin capabilities mentioned in the issue, including flash cards. Done means the documentation explains what users can do and why they should use it, rather than only how developers enable it; clarify the desired screenshots and scope with the referenced contributor.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.