docs(components): Document composability best practices [107012] #2136
Conversation
Deploying atlantis with
|
| Latest commit: |
dabe1a9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5c3cafa2.atlantis.pages.dev |
| Branch Preview URL: | https://job-107012-composability-doc.atlantis.pages.dev |
|
overall I'm thinking about who this guide is for, or what persona. I would say most of our guides are for people looking to learn about Atlantis and use it. we have very little, if any content, for Atlantis internal dev team about decision making so I'm not sure this is the best place for that type of content though I do think we should document that! also looking around the docs site I found a section about composing components. I think this link is broken, or I don't get why it is a standalone section at the very least that aside, we do have a section about composition I'm thinking the guides on how to customize Atlantis components, or compose them might be a better fit there |
| @@ -89,7 +89,7 @@ For this example we are going to build a card that allows you to enter a topic | |||
| and then search for a related gif. | |||
|
|
|||
| <Canvas> | |||
| <Story name="Composing Components"> | |||
| <Story name="Gif Gift"> | |||
There was a problem hiding this comment.
I played around with this for ~20mins to try to prevent the split of a Docs page and a page with this story but still having it render nicely in this docs page and couldn't get it. At least now it has a better name.
There was a problem hiding this comment.
haha I don't get why this is its own section. that can't be by design. something must have changed in a storybook upgrade or something.
Aiden-Brine
force-pushed
the
JOB-107012/composability-docs
branch
from
883238b to
d82247c
Compare
| #### 3. Compound Components: | ||
|
|
||
| Examples: [Chip](..?path=/docs/components-selections-chip--docs), | ||
| [DataList](..?path=/docs/components-lists-and-tables-datalist--docs) |
There was a problem hiding this comment.
DataList is almost in its own category. it's bordering on an entire feature/view.
I suppose it is technically a compound component though. it's just the largest compound component we have.
| #### 4. Strict Complex Components: | ||
|
|
||
| Example: | ||
| [Autocomplete](..?path=/docs/components-forms-and-inputs-autocomplete--docs), |
There was a problem hiding this comment.
we'll have to make a note to update these if we ever make Autocomplete less strict
There was a problem hiding this comment.
General comment, we should follow our own formatting guidance around capitalization:
Use sentence-case for almost all typographic content, with the exception of instances where all-caps is a stylistic decision (i.e. MON WED TUE as calendar weekday headers).
This means in general, capitalize only the first letter of the content unless there is a proper noun (such as a person's name) involved. This applies to headings and titles, as well as card headers and menu options.
(This could be done in a follow-up PR)
|
still LGTM since I know we don't remove the approved status after a commit (we probably should) |
Motivations
There has been a lot of discussion and work around making our Atlantis components more composable. We decided it would be a good idea to get some documentation added for consumers to better understand our philosophy towards customization and our approach.
Changes
Added
New documentation
Changed
Deprecated
Removed
Fixed
Security
Testing
N/A
Changes can be
tested via Pre-release
In Atlantis we use Github's built in pull request reviews.