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.

Sign up for GitHub

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

Jump to bottom

Enrich docs with @summary and @title from custom-elements.json #952

Merged
merged 2 commits into from Oct 18, 2022
Merged

Enrich docs with @summary and @title from custom-elements.json #952

merged 2 commits into from Oct 18, 2022

Conversation

trailsnail
Copy link
Contributor

@trailsnail trailsnail commented Oct 13, 2022 •
edited

This is a preparation PR for #947

Relates to #946

Docs are now enriched with summary and title from custom-elements.json if components JSDocs containes them.

@vercel
Copy link

vercel bot commented Oct 13, 2022 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
shoelace ✅ Ready (Inspect) Visit Preview Oct 13, 2022 at 11:15AM (UTC)

@trailsnail trailsnail mentioned this pull request Oct 13, 2022
Merged
1 task
@trailsnail trailsnail changed the title WIP: provide [component-description:COMPONENT_NAME] markdown for docs WIP: Provide rendering components @summary|@title into docs Oct 18, 2022
@trailsnail trailsnail changed the title WIP: Provide rendering components @summary|@title into docs WIP: Enrich docs with @summary and @title from custom-elements.json Oct 18, 2022
@trailsnail trailsnail marked this pull request as ready for review October 18, 2022 15:09
@trailsnail trailsnail changed the title WIP: Enrich docs with @summary and @title from custom-elements.json Enrich docs with @summary and @title from custom-elements.json Oct 18, 2022
@trailsnail
Copy link
Contributor Author

@claviska
Would you please review this PR as preparation for #947?
If you merge this, we have the functionality to go on with changing the components to use it.

I wanted to split context to count my Hacktober PRs 😉

@claviska claviska merged commit 0cba469 into shoelace-style:next Oct 18, 2022
@claviska
Copy link
Member

Done, thanks!

@trailsnail trailsnail deleted the markdown branch October 19, 2022 06:53
@trailsnail trailsnail mentioned this pull request Oct 24, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@claviska claviska claviska approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@trailsnail @claviska