-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Oppia UX guidelines & rationales
Sean Lip edited this page Mar 23, 2022
·
5 revisions
You can find all of Oppia's design guidelines here. Note that this is a living document, so it will be updated over time and some sections may be incomplete right now (as of 24 Mar 2022).
-
Modal with form(s) inside it.
- It should only get closed if the user clicks the dedicated close button or by pressing the ESC key.
- Example:
-
Modals with warnings or suggestions.
-
It should get closed through the dedicated close button or just by clicking outside the modal i.e, in the background or by pressing ESC key.
-
Example:
-
-
Modals which don't have a close button.
-
It should not get closed by users through any process.
-
Example:
-
Have an idea for how to improve the wiki? Please help make our documentation better by following our instructions for contributing to the wiki.
Core documentation
Developing Oppia
- FAQs
- Installing Oppia
- Getting started with the codebase
- Making your first PR
- Learning resources for developers
- Codebase Overview
- Coding Guidelines
- Coding style guide
- Guidelines for creating new files
- How to add a new page
- How to write frontend type definitions
- How to write design docs
- Revert and Regression Policy
- Server errors and solutions
-
Debugging
- If your presubmit checks fail
- If CI checks fail on your PR
- Finding the commit that introduced a bug
- Interpreting GitHub Actions Results
- Debugging Docs
- Debugging datastore locally
- Debugging end-to-end tests
- Debugging backend tests
- Debugging frontend tests
- Debug frontend code
- Debugging custom ESLint check tests
- Debugging custom Pylint check tests
- Debugging Stories
- Guidelines for launching new features
- Guidelines for making an urgent fix (hotfix)
- Lint Checks
- Oppia's code owners and checks to be carried out by developers
- Privacy aware programming
- Backend Type Annotations
- Bytes and string handling in Python 3
- Guidelines for Developers with Write Access to oppia/oppia
- Testing
- Release Process
Developer Reference
- Oppiabot
- Frontend
- Backend
- Translations
- Webpack
- Third-party libraries
- Extension frameworks
- Oppia-ml Extension
- Mobile development
- Mobile device testing
- Performance testing
- Build process
- Team structure
- Triaging Process
- Playbooks
- Wiki
- Past Events