apify
Keep node.js (and possibly other versions) up-to-date
Currently, we have versions for node.js, python, etc. in plain text, in the docs. It would be great to have "one source of truth" across our docs to avoid out dated docs.
In previous job we solved this by having one file .yml file in the root that acted as source of truth. Instead of writing plain text version we had key:value pairs like so
node: 24
python: 3.14
and in .md files we wrote some token that during build was switched with the value from the source of truth.
I think that it is great solution, I saw it as well in other docs repos
Tho... now that I think about it, how will that affect LLM's? Or more importantly .md versions? Are they created of final HTML version? or from raw .md files? Won't this make it less readable for them?
The public markdown pages are rendered, we don't serve the source files directly (those would have front matter and their file names might not match the actual URL).
I am not entirely sure what versions are we talking about here, we usually state minimal supported versions of node and python, those shouldn't be the latest stable, quite the opposite.
But the issue is rather that we have it in multiple places, even if this is minimal supported version. The idea would be to have one source of truth, in which we would change the version if needed that would get then propagated to every occurence
Technically, those can differ for each project, the source of truth is in those projects, e.g. https://github.com/apify/apify-sdk-js/blob/master/packages/apify/package.json#L5-L7
e.g. the CLI requires a newer node as opposed to the rest
That is a valid point, thanks. I perused main repo quickly I think we just have 2 or 3 places where we mention it so it's not the worst situation to be in. But if we would start expanding tutorials & guides & how to's I can foresee the # raising fairly quickly. I guess this is more about future proofing.
But it would have to be done then per repository/per project, not through one overarching file