User:MSchottlender-WMF/ooui-doc-draft
This is a concept write-up for starting OOjs UI documentation.
The rationale behind this is to organize the documentation in a conceptually logical way, so we can make sure developers know where to start, and we can collaboratively write and maintain the documentation.
The idea is that once a developer understands the rationale of why things are built a certain way, it is much easier to get into multiple widgets and implementation details. On top of that, we build separate documentation for quick-info if a developer 'just' wants to create a one-off widget without getting all in to the logic and operation of OOjs UI. In between the documentation we should include hands-on tutorials and walk-throughs.
Please feel free to add, adjust, or link to a page if you've written it.
Section | Concept/Description | Existing pages for reference / replacement |
---|---|---|
Introduction |
|
About the library |
Getting started |
|
Creating interfaces programmatically |
Working with widgets |
|
OOjs UI/Elements
OOjs UI/Layouts/Booklets and Pages OOjs UI/Layouts/Fields and Fieldsets
OOjs UI/Layouts/Stacks and Panels OOjs UI/Widgets/Buttons and Switches OOjs UI/Widgets/Icons, Indicators, and Labels OOjs UI/Widgets/Selects and Options OOjs UI/Windows/Message Dialogs OOjs UI/Windows/Process Dialogs OOjs UI/Windows/Simple messages |
Extending widgets |
|
|
Advanced concepts | Generalizing a widget for upstream into ooui |