Content
View differences
Updated by Parimal Satyal about 3 years ago
### Context
Our design system docs pages don't always have the same basic structure, which makes writing new documentation difficult. Over time, as we write more docs and add more code examples, we've learnt more about what's possible, what's useful and what's desirable.
Before we write/re-write the date picker documentation (task <mention class="mention" data-id="46220" data-type="work_package" data-text="#46220">#46220</mention>), it would help to define a common structure for documenting our components.
### The Goal
As discussed with <mention class="mention" data-id="42086" data-type="user" data-text="@Wieland Lindenthal">@Wieland Lindenthal</mention>, the The goal of this task is to define a common structure for design system stories so that both designers and developers and contribute and complete documentation of each component.
### The Process
1. Post this initial proposition of structure on Storybook [in a separate PR](https://community.openproject.org/#) with two new stories:
1. Date picker
2. Breadcrumps
2. Iterate/discuss and complete the two examples (rough)
3. Modify structure if we think it's necessary
4. Complete documentation for one element with the new structure to see if it works
### To do
* [x] Parimal creates 2 storybook stories (test) with new structure
* [ ] Wieland/Parimal bring it up on a front-end daily, find a time to discuss it
* [ ] Devs/Designers iterate on the structures and come up with a "final"-ish strcuture
* [ ] Devs/Designers write one whole story (date picker? something simpler?) with new structures
* [ ] Come up with more helpful semantics than "component", which can lead to confusion (Angular component or Figma component?)
Our design system docs pages don't always have the same basic structure, which makes writing new documentation difficult. Over time, as we write more docs and add more code examples, we've learnt more about what's possible, what's useful and what's desirable.
Before we write/re-write the date picker documentation (task <mention class="mention" data-id="46220" data-type="work_package" data-text="#46220">#46220</mention>), it would help to define a common structure for documenting our components.
### The Goal
As discussed with <mention class="mention" data-id="42086" data-type="user" data-text="@Wieland Lindenthal">@Wieland Lindenthal</mention>, the
### The Process
1. Post this initial proposition of structure on Storybook [in a separate PR](https://community.openproject.org/#) with two new stories:
1. Date picker
2. Breadcrumps
2. Iterate/discuss and complete the two examples (rough)
3. Modify structure if we think it's necessary
4. Complete documentation for one element with the new structure to see if it works
### To do
* [x] Parimal creates 2 storybook stories (test) with new structure
* [ ] Wieland/Parimal bring it up on a front-end daily, find a time to discuss it
* [ ] Devs/Designers iterate on the structures and come up with a "final"-ish strcuture
* [ ] Devs/Designers write one whole story (date picker? something simpler?) with new structures
* [ ] Come up with more helpful semantics than "component", which can lead to confusion (Angular component or Figma component?)