Docs automatically/periodically update when new software versions are release (e.g., lotus, go)
Done Criteria
When a new version of critical software referenced in the docs (e.g., lotus, go) is released, the docs should update to reference this version instead of a static outdated version from the paste. This update should come through as a PR that gets reviewed/approved.
Why Important
Many docs.filecoin.io docs are for helping users get started. We won't want to start them off on the wrong foot using outdated versions.
User/Customer
- Doc consumers so they get accurate / updated information
- Doc maintainers so they don't have to do manual updates
Notes
- At least as of 2025-01-10, https://docs.filecoin.io/nodes/lite-nodes/spin-up-a-lite-node is a good example. It references lotus v1.29 even though that is from a previous network version.
- A github action workflow where this is done for lotus docs is https://github.com/filecoin-project/lotus-docs/blob/main/.github/workflows/update-version.yml . It handles
lotus,lotus-miner, andgo. Here is a sample PR it created: https://github.com/filecoin-project/lotus-docs/pull/775 . (Lotus Docs is using Hugp templating I think for referencing these values. I assume something similar can be done for GitBook.) - Here is an example for ipfs-docs: https://github.com/ipfs/ipfs-docs/blob/main/.github/workflows/update-on-new-ipfs-tag.yml
@lanzafame @smagdali : given your engagement on https://github.com/filecoin-project/filecoin-docs/pull/2312 , is this something you think you would take on?
Cc @rjan90 as FYI given past discussions we've had in the Lotus release process about updating corresponding docs when new Lotus versions are released.
Yes, I've wanted to have this happen forever.