Official Documentation

• edX documentation:
• edX Insights
• Open Learning XML specification (OLX)
• edX Developers Guide
• Developing on the edX Developer Stack
• Open edX Technical Architecture
• XBlock API docs
• Debugging EdX
• Standards, requirements, and expectations
  • Code Review Guidelines & Gotchas (private) Contains some outdated information, e.g. Teaching & Learning (TNL) was the edX team doing code reviews.
  • edX Python Coding Standards and code quality standards
  • edX Browser Support
  • edX Accessibility Guidelines
  • Accessibility mandatory course
  • UX Pattern Library
• Testing
  • Testing documentation
  • Test engineering FAQ
  • Jenkins Guide - Jenkins runs the automated tests as part of the pull request process
• How to:
  • How to report bugs to edX
  • Handling flaky tests
  • Running performance tests (private)
  • Cross-Browser Testing
  • DevOps HOWTOs
  • SASS guide

---

Last update: 2022-11-22