openedx / openedx/paragon

New docs site

Open
#4,312 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

Planning issue to discuss what we're looking for in a new docs site.

  • Things we should keep
    • Live editable code examples
    • Runtime theme loading/switching
    • Usage guidelines
      • Opportunity to improve as we go
  • Things we should add
    • Real-world examples
      • Like usage insights but better
        • With frontend-base converted frontend apps we might be able to do this by importing components from npm published apps.
    • Recommended ways to use something (in comparison to all the different ways it is used throughout frontend apps)
      • Clear distinction between human recommendations and machine gathered usage data
        • How to classify? Way to say "this is good, we should consider how to better support this in/with paragon" and "we haven't looked at this, we should see if this is a bad pattern we should try to replace" etc.
  • Things we should change
    • Structure (follow atomic design hierarchy)
  • Things we should remove
    • //todo

Other thoughts:

  • What "wrapper" components in frontend apps are good vs bad

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

This is a planning issue; no implementation files, tests, or entry points are named. Start by reviewing the listed keep/add/change/remove goals and the linked Paragon issue #3785 and pull request #3777. Done is an agreed scope and structure for the new documentation site, not a defined code change.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
design, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.