openedx / openedx/docs.openedx.org

An Index for all ADRs

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

Nobody has claimed this yet.

developers
Dominant language
JavaScript
Stars
35
Forks
95
Avg merge
5d 15h
Merged PRs (30d)
3

Description

As a Developer, I'd love to be able to find a central index of all the ADRs so I can easily keep track of ADR deltas across multiple repos/projects.

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

No files, tests, or entry points are named. Start by inspecting the documentation structure and locating the existing ADRs across the referenced repositories or projects; done should be a central, maintained index that makes ADR changes discoverable across them.

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
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.