Update component descriptions and associated declaration #108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rachelmarconi
approved these changes
Jul 18, 2024
mitchthorson
approved these changes
Jul 19, 2024
.github/pull_request_template.md
Outdated
| @@ -17,3 +17,4 @@ Tell us what this PR does or link to any related issues that describe the goal h | |||
| - [ ] Added any changes in this PR to the `CHANGELOG.md` `Next` section | |||
| - [ ] If this pull request includes a new component or feature, has it been exported from one of the library's entry points? | |||
| - [ ] Does the component dispatch relevant interaction events? (ie: on:click, on:change, etc.) | |||
| - [ ] Does the component directory include a separate `.docs.md` imported into `.stories.svelte` for description and usage information? | |||
There was a problem hiding this comment.
Suggested tweak: Make this language more specific about including "description and usage information" but maybe leave out the import seperate .docs.md ? I'm thinking about cases where a component needs custom mdx docs for more robust formats (See maps/SVGMap/SVGMap.docs.mdx) where this might not apply.
There was a problem hiding this comment.
Just updated! Let me know what you think.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's in this pull request
Description
Among other tasks, the main purpose of this PR is to update the way in which long, html-based descriptions are being imported into
.stories. Other tasks include:descriptionfield from top level meta object (doesn't render)htmlinstead ofsvelteBefore submitting, please check that you've
CHANGELOG.mdNextsection