Skip to content

ci: check for unused snippets - #108

Open
gcomte wants to merge 2 commits into
mainfrom
ci/check-unused-snippets
Open

ci: check for unused snippets#108
gcomte wants to merge 2 commits into
mainfrom
ci/check-unused-snippets

Conversation

@gcomte

@gcomte gcomte commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Fails snippet CI when an anchored source snippet is unused.

Temporarily excludes React Native snippets until September 11, 2026 because the React Native library is not yet ready. The snippets will be reintroduced once the React Native library is on SDK version 0.10.0 as well.

@gcomte
gcomte force-pushed the ci/check-unused-snippets branch 3 times, most recently from 8ddcccb to 3f296f5 Compare August 11, 2026 09:25
@gcomte
gcomte marked this pull request as ready for review August 11, 2026 09:27
@gcomte
gcomte force-pushed the ci/check-unused-snippets branch from 3f296f5 to 3b549bd Compare August 11, 2026 09:27
@gcomte
gcomte force-pushed the ci/check-unused-snippets branch from 3b549bd to 61aa854 Compare August 11, 2026 10:00

@86667 86667 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Im not convinced that this is necessary - what is the harm in having some unused snippets really?

Also, a linter would likely be an easier way to identify unused code.

This feels like polish which will only get in the way whilst the repo is in its current development stages

@gcomte

gcomte commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator Author

what is the harm in having some unused snippets really?

The goal is to protect us from unnecessary maintenance work.
Granted, it introduces new maintenance work which is taking care of the checker.

Also, a linter would likely be an easier way to identify unused code.

I don't see how you would achieve the same thing with a linter

This feels like polish which will only get in the way whilst the repo is in its current development stages

How would it get in our way? You mean if you created a snippet, but don't want to reference it in the docs yet? Then you could just exclude it, right? At least you are conscious that there is 'dead code' or rather 'dead docs'.

@gcomte gcomte added the blocked label Aug 13, 2026
@gcomte

gcomte commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator Author

Blocked: Won't be merged until we're done with a major restructuring of the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants