Skip to content

Commit 96ba14b

Browse files
Add warning note on finding docs for release versions (apple#676)
## Type of Change - [ ] Bug fix - [ ] New feature - [ ] Breaking change - [x] Documentation update ## Motivation and Context Closes apple#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 <[email protected]>
1 parent e54ee7c commit 96ba14b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ uninstall-container.sh -k
5858
- [Build and run](./BUILDING.md) `container` on your own development system.
5959
- View the project [API documentation](https://apple.github.io/container/documentation/).
6060

61+
> [!IMPORTANT]
62+
> 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.
63+
>
64+
> Example: [release 0.4.1 tag](https://github.com/apple/container/tree/0.4.1)
65+
6166
## Contributing
6267

6368
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.

0 commit comments

Comments
 (0)