You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
write a short component description for each component in a JSDoc above the export default section
rename ApiComponentExample to ApiCardInteractive
renameMarkdownSection and CodeBlockSection to something else:
So we have some components which end in ...Section because they are to be used as a documentation "section", which incorporate whatever ... stands for with an extra section of some text?
This makes sense.
However, MarkdownSection and CodeBlockSection are a bit different as they just allow the use of a filePath as opposed to Markdown and CodeBlock.
Things to think about:
is it really necessary to separate Markdown and CodeBlock with their counterparts that can accept a filePath?
I believe so because projects not relying on webpack that still want to use Markdown might have problems when the webpack related code is included. But we need to rename Section to something else.
The text was updated successfully, but these errors were encountered:
Prerequisite
#19
Goal
write a short component description for each component in a JSDoc above the
export default
sectionrename
ApiComponentExample
toApiCardInteractive
rename
MarkdownSection
andCodeBlockSection
to something else:So we have some components which end in
...Section
because they are to be used as a documentation "section", which incorporate whatever...
stands for with an extra section of some text?This makes sense.
However,
MarkdownSection
andCodeBlockSection
are a bit different as they just allow the use of afilePath
as opposed toMarkdown
andCodeBlock
.Things to think about:
I believe so because projects not relying on webpack that still want to use
Markdown
might have problems when the webpack related code is included. But we need to renameSection
to something else.The text was updated successfully, but these errors were encountered: