filecoin-project / filecoin-project/filecoin-docs

Docs automatically/periodically update when new software versions are release (e.g., lotus, go)

Open
#2,348 2 comments 0 reactions 2 assignees Assigned to @smagdali View on GitHub
Dominant language
JavaScript
Stars
228
Forks
321
Avg merge
6d 9h
Merged PRs (30d)
1

Description

## 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
1. Doc consumers so they get accurate / updated information
2. Doc maintainers so they don't have to do manual updates

## Notes
1. 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.
2. 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`, and `go`. 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.)
3. Here is an example for ipfs-docs: https://github.com/ipfs/ipfs-docs/blob/main/.github/workflows/update-on-new-ipfs-tag.yml

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.