From 96ba14bc21079b72c931952b28096ce2e6e581cb Mon Sep 17 00:00:00 2001 From: Kathryn Baldauf Date: Tue, 23 Sep 2025 15:22:58 -0700 Subject: [PATCH] Add warning note on finding docs for release versions (#676) ## Type of Change - [ ] Bug fix - [ ] New feature - [ ] Breaking change - [x] Documentation update ## Motivation and Context Closes https://github.com/apple/container/issues/638. This PR adds a warning in the README for the documentation links to help newcomers find the correct documentation based on the version of `container` they are running. ## Testing - [ ] Tested locally - [ ] Added/updated tests - [x] Added/updated docs Signed-off-by: Kathryn Baldauf --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index f207c60e..6652a257 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,11 @@ uninstall-container.sh -k - [Build and run](./BUILDING.md) `container` on your own development system. - View the project [API documentation](https://apple.github.io/container/documentation/). +> [!IMPORTANT] +> The links above are for the CURRENT BRANCH's documentation. To find documentation for official releases, find the target release on the [Release Page](https://github.com/apple/container/releases) and click the tag corresponding to your release version. +> +> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1) + ## Contributing Contributions to `container` are welcomed and encouraged. Please see our [main contributing guide](https://github.com/apple/containerization/blob/main/CONTRIBUTING.md) for more information.