Files
wekan/docs/Design/Design-Principles.md
T
Lauri Ojansivu b7589737f5 File docs/Features the way the WeKan menus are.
A feature's guide now sits under the menu it is used from, read from the
templates rather than from where somebody once put it: Header-Bar,
All-Boards, Pages, Board-Header (search and every Board View), Board-Sidebar
(Board Settings, Filter, Members, Labels, Archive), Rules, Swimlanes, Lists,
Cards, Member-Settings, Admin-Panel and Login-Page. Topics used from several
menus (editor, history, theme, translations, email, troubleshooting) are in
General.

- Each area has a README mapping its menu entries to their guides and to the
  template or server module that implements them. Board-Header/README.md
  lists all 40 Board View entries with the template boardBody.jade renders;
  five views (Table, Calendar Mode, Time, Timeline, Map) have no guide of
  their own yet and say so.
- Board-View.md listed 25 views while BOARD_VIEWS has 40; it now lists all
  of them with their English labels.
- Pages keep their file names. Where a released changelog links an old path,
  a "# Moved" page stays there and points to the new one; test-menu.sh skips
  folders holding only those.
- Undo was filed under Login; it is General/Undo now.
- Every link in docs, code comments, scripts and tests follows the move;
  docsLinksResolve checks them all.

Tests that read a doc follow it to its new place. boardViewSettings now fails
when Board-View.md or Board-Header/README.md differs from BOARD_VIEWS, or
names a template boardBody.jade does not render.

Thanks to xet7 !
2026-10-16 23:45:35 +03:00

37 lines
2.0 KiB
Markdown

## WeKan Design Principles
- 2024-08 Design discussion here: https://github.com/wekan/wekan/discussions/5507
- Original WeKan Design:
- Uses WeKan style confirm popups `Popup.afterConfirm(` , translations etc. Please look at existing code to keep same style.
- Kanban, the good parts. Like was done when figuring out best design for Swimlanes https://github.com/wekan/wekan/issues/955
- Intuitive, easy to figure out, prevent messing up something [Monkey Proof Software](Monkey-Proof-Software.md)
- Polished UI/UX
- Menu options are there where you would expect then to be.
- Try to fix anything unexpected.
- New features added there where it makes most sense.
- Not too many toggles and settings, because that is worse. For example, Discord settings has too many toggles and settings. Just select some default.
- FOSS with MIT license
- Swimlanes
- All the use cases of WeKan feature/fix contributors
- Cross-platform. Support many CPU/OS/Browsers for Desktop and Mobile.
- Support many browsers [Browser compatibility matrix](../Browsers/Browser-compatibility-matrix.md) . Add support for more.
- PWA [PWA](../Browsers/PWA.md)
- On-Premise:
- Linux amd64/arm64/s390x
- https://wekan.fi/install/
- [Raspberry Pi](../Platforms/FOSS/HW/RaspberryPi/Raspberry-Pi.md)
- Windows [Offline](../Platforms/Propietary/OS/Windows/Offline.md)
- Mac [Mac](../Platforms/Propietary/OS/Mac)
- Not like other software:
- But note that design of all software changes often, when they are in active development.
- Not bad parts of Trello:
- Not the exact design of Trello [FAQ](../FAQ/FAQ.md#why-does-wekan-look-so-different-now-compared-to--v09)
- Not so many duplicate menus and texts like Trello
- Not so much empty space
- Some good parts of Trello:
- Import from Trello
- Shortcuts https://github.com/wekan/wekan/issues/1878
- IFTTT Rules like Trello Butler [IFTTT](../Features/Rules/IFTTT/IFTTT.md)
- Progress bar of checklist
- Some good parts of Jira:
- Multiple assignees