Skip to content

feat(daffio): create doc heading component - #3897

Merged
xelaint merged 2 commits into
developfrom
docs-heading-component
Aug 11, 2025
Merged

feat(daffio): create doc heading component#3897
xelaint merged 2 commits into
developfrom
docs-heading-component

Conversation

@xelaint

@xelaint xelaint commented Aug 7, 2025

Copy link
Copy Markdown
Member

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #3895, fixes: #3893, fixes: #3894

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@xelaint
xelaint requested review from a team as code owners August 7, 2025 19:18
@xelaint xelaint added package: daff.io @daffodil/daff.io status: wip This PR is WIP. It should be marked as a draft. labels Aug 7, 2025
@xelaint
xelaint marked this pull request as draft August 7, 2025 19:18
@griest024
griest024 marked this pull request as ready for review August 8, 2025 17:59
@xelaint

xelaint commented Aug 8, 2025

Copy link
Copy Markdown
Member Author

@griest024 should this also be added to readme headings too? (e.g. design component docs, guides docs)

@griest024

Copy link
Copy Markdown
Member

@griest024 should this also be added to readme headings too? (e.g. design component docs, guides docs)

Yes but those are markdown rendered and so it's more complicated to do so. We could expose the heading component as a custom element and then customize the markdown rendering of headings.

@xelaint

xelaint commented Aug 8, 2025

Copy link
Copy Markdown
Member Author

@griest024 should this also be added to readme headings too? (e.g. design component docs, guides docs)

Yes but those are markdown rendered and so it's more complicated to do so. We could expose the heading component as a custom element and then customize the markdown rendering of headings.

Do you want to do this in a separate PR?

@griest024

Copy link
Copy Markdown
Member

@griest024 should this also be added to readme headings too? (e.g. design component docs, guides docs)

Yes but those are markdown rendered and so it's more complicated to do so. We could expose the heading component as a custom element and then customize the markdown rendering of headings.

Do you want to do this in a separate PR?

Yeah I think so. Custom elements opens a can of worms

@xelaint
xelaint merged commit 1ea4162 into develop Aug 11, 2025
6 checks passed
@gray-bot gray-bot mentioned this pull request Aug 11, 2025
This was referenced Sep 4, 2025
@gray-bot gray-bot mentioned this pull request Sep 4, 2025
@damienwebdev
damienwebdev deleted the docs-heading-component branch September 8, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

package: daff.io @daffodil/daff.io status: wip This PR is WIP. It should be marked as a draft.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create doc heading component/directive Use Heading Component to make doc headings clickable Allow headings in docs to be clickable

2 participants