[WIP] components doc changes to include elements and components #126
Conversation
| icon: "cube" iconType: "solid" | ||
| --- | ||
|
|
||
| Makeswift leverages the power of React to give you unparalleled flexibility and control over your website's design and functionality on an ongoing basis. |
There was a problem hiding this comment.
Would it make sense to not mention react to start since for visually created components, code doesn't factor in?
There was a problem hiding this comment.
I don't disagree, but this is from the current Product Components documentation haha.
product/components.mdx
Outdated
|
|
||
| <Columns cols={2}> | ||
| <Card title="Built-in Components" icon="code"> | ||
| Code components that are registered with your host. |
There was a problem hiding this comment.
I liked the potential to include "Code" and "Visual" in parenthesis with these. So:
Built-in (Code) Components
Global (Visual) Components
or
Built-in Components (Code)
Global Components (Visual)
or
Built-in Components (Created in Code)
Global Components (Created Visually)
There was a problem hiding this comment.
I opted to include this in the description on the card instead but open to including it in parentheses!
product/components.mdx
Outdated
|
|
||
| #### Navigation Bar | ||
|
|
||
| Implementing a Built-in Element for a Navigation bar allows for all new pages to automatically include a Navigation bar, without having to add them manually. Furthermore, any edits to the Navigation will propogate to all new and existing pages. |
There was a problem hiding this comment.
Can we link to the code example in the documentation? https://docs.makeswift.com/developer/reference/components/makeswift-component#example
| </Frame> | ||
|
|
||
| #### Blogs | ||
|
|
There was a problem hiding this comment.
to clarify, I don't know how to create Built-in elements so I need help with a similar image to the built-in element nav bar here. Maybe you can help me with that?
|
As I read this, I think it makes more sense to break these into separate docs for Components and Elements. That makes each doc a bit more digestible and also gives us the ability to link to the separate pages for specific details to one or the other |
Co-authored-by: James Q Quick <[email protected]>
Co-authored-by: James Q Quick <[email protected]>
Co-authored-by: James Q Quick <[email protected]>
Co-authored-by: James Q Quick <[email protected]>
Co-authored-by: James Q Quick <[email protected]>
Co-authored-by: James Q Quick <[email protected]>
Changed the components product docs to highlight the differences between components and elements as well as define built-in components and built-in elements.