Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start to document components #162

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Conversation

fengelniederhammer
Copy link
Collaborator

@fengelniederhammer fengelniederhammer commented Apr 23, 2024

resolves #129

Summary

This is mostly meant to update the README as a preparation to publish a first version as an NPM package.

This also sketches how we can document components using Storybook. If you like this approach, we can create follow-up issues to document all existing components.

Screenshot

This is the Storybook docs page for the location filter. Most parts of this are autogenerated from the custom-elements.json.
image

PR Checklist

  • [ ] The implemented feature is covered by an appropriate test.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we notice that there is a pattern across all components, we can also think about using a customized docs template: https://storybook.js.org/docs/writing-docs/doc-blocks#customizing-the-automatic-docs-page

Copy link
Collaborator

@JonasKellerer JonasKellerer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start.
LGTM.

@fengelniederhammer fengelniederhammer merged commit 43fb24f into main Apr 24, 2024
4 checks passed
@fengelniederhammer fengelniederhammer deleted the 129-document-components branch April 24, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document components
2 participants