Repository navigation
Make sure all code examples are runnable #7293
Description
Broken out of #7197
At Collab Summit we discussed that there have been instances of the code examples not being runnable snippets.
There are many ways we could approach this, but they all have the same characteristics:
- execute the code samples against ACTIVE version of Node.js
- display the code samples on the website
Whether or not the authoritative source code remains on the website or elsewhere represents work and pros/cons for website maintenance and approachability.
@bnb had some more thoughts on how to accomplish this, but I don't think we have any concrete approaches yet.
Activity
AugustinMauroy commentedon Nov 29, 2024
Shouldn't we use the LTS because that's what's recommended on the home page?
ovflowd commentedon Nov 29, 2024
Maybe we should add a tag on each snippet called version="current" or version="lts" so we know which version to run the snippet against.
And then we can also visually add the label with a tooltip so people know if the latest lts or current version support said feature
bmuenzenmeyer commentedon Nov 30, 2024
The home page recommends 22 right now, which is ACTIVE.
ovflowd commentedon Nov 30, 2024
Wdym with active? 22 is LTS.
bmuenzenmeyer commentedon Nov 30, 2024
ACTIVE
AugustinMauroy commentedon Nov 30, 2024
If we go back to the idea of having the version for which the document was designed in metadata. This makes it possible to keep the code functional on a given version.