Repository navigation
Consolidate code snippets from the docs and /examples folder #1167
Description
Activity
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you believe this is a mistake, please reply to this comment to keep it open. If there isn't one already, a PR to fix or at least reproduce the problem in a test case will always help us get back on track to tackle this.
It's not really clear what snippets, could you maybe clarify if this is still relevant?
Reacted by SamuelI would like to contribute
Need some more information here, what exactly the Consolidate code snippets is.
Need some more information here, what exactly the Consolidate code snippets is.
Waiting
Hi, I'd like to work on this. I'll audit the current docs snippets vs the /examples folder and propose a consolidation plan. Is this still relevant and would a PR be welcome?
Reacted by Christophe CHARLESI would like to contribute if help is still needed. If so, I would like more information.
Hi, I'd like to work on this issue as my first contribution. Is it still available ? If so, Could you please assign the issue to me? Thank you !
Hi! I'd like to take this on as my first contribution. I did an initial audit of the two sets:
docs/examples/— runnable Gradle projects embedded in the docs (junit4/generic,junit4/redis,junit5/redis, …), kept compilable by CIexamples/— 19 standalone projects linked fromdocs/examples.md
Proposed approach:
- Full duplication audit — docs snippets overlapping
examples/projects, plus anyexamples/projects not referenced from the docs - Consolidate a first batch (move/de-dupe while preserving the runnable-docs guarantee, e.g. snippet includes from
examples/into docs pages) - Update
docs/examples.mdso everything underexamples/is discoverable
Does this direction work for you, or would you prefer a narrower first PR?
Followup of #1150.
Since the snippets are runnable now, we could merge them with the examples we have to improve the discoverability and reduce the duplicates between those two sets.