From 1470e8bcf26c4acebdc0652c9a28cf2a3a82d2c3 Mon Sep 17 00:00:00 2001 From: Miyoung Choi Date: Wed, 1 Apr 2026 16:03:44 -0700 Subject: [PATCH 1/2] docs: add disclaimer and alpha banner --- README.md | 6 +++++- docs/conf.py | 4 ++++ docs/index.md | 6 ++++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5549fa7b4..a4bfac641 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# OpenShell +# NVIDIA OpenShell [![License](https://img.shields.io/badge/License-Apache_2.0-blue)](https://github.com/NVIDIA/OpenShell/blob/main/LICENSE) [![PyPI](https://img.shields.io/badge/PyPI-openshell-orange?logo=pypi)](https://pypi.org/project/openshell/) @@ -229,6 +229,10 @@ All implementation work is human-gated — agents propose plans, humans approve, OpenShell is built agent-first — your agent is your first collaborator. Before opening issues or submitting code, point your agent at the repo and let it use the skills in `.agents/skills/` to investigate, diagnose, and prototype. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full agent skills table, contribution workflow, and development setup. +## Notice and Disclaimer + +This software automatically retrieves, accesses or interacts with external materials. Those retrieved materials are not distributed with this software and are governed solely by separate terms, conditions and licenses. You are solely responsible for finding, reviewing and complying with all applicable terms, conditions, and licenses, and for verifying the security, integrity and suitability of any retrieved materials for your specific use case. This software is provided "AS IS", without warranty of any kind. The author makes no representations or warranties regarding any retrieved materials, and assumes no liability for any losses, damages, liabilities or legal consequences from your use or inability to use this software or any retrieved materials. Use this software and the retrieved materials at your own risk. + ## License This project is licensed under the [Apache License 2.0](https://github.com/NVIDIA/OpenShell/blob/main/LICENSE). diff --git a/docs/conf.py b/docs/conf.py index a54d72435..9afa14409 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,6 +93,10 @@ highlight_language = "console" html_theme_options = { + "announcement": ( + "🔔 NVIDIA OpenShell is alpha software. APIs and behavior" + " may change without notice. Do not use in production." + ), "icon_links": [ { "name": "GitHub", diff --git a/docs/index.md b/docs/index.md index 37d49047b..f7a54ae47 100644 --- a/docs/index.md +++ b/docs/index.md @@ -176,6 +176,12 @@ Policy schema, environment variables, and system architecture. :::: +--- + +```{important} Notice and Disclaimer +This software automatically retrieves, accesses or interacts with external materials. Those retrieved materials are not distributed with this software and are governed solely by separate terms, conditions and licenses. You are solely responsible for finding, reviewing and complying with all applicable terms, conditions, and licenses, and for verifying the security, integrity and suitability of any retrieved materials for your specific use case. This software is provided "AS IS", without warranty of any kind. The author makes no representations or warranties regarding any retrieved materials, and assumes no liability for any losses, damages, liabilities or legal consequences from your use or inability to use this software or any retrieved materials. Use this software and the retrieved materials at your own risk. +``` + ```{toctree} :hidden: From 7495260338c3c8f10e911412be70edf04a1ea007 Mon Sep 17 00:00:00 2001 From: Miyoung Choi Date: Wed, 1 Apr 2026 16:10:58 -0700 Subject: [PATCH 2/2] docs: small fix --- docs/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index f7a54ae47..1a825beeb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -178,7 +178,9 @@ Policy schema, environment variables, and system architecture. --- -```{important} Notice and Disclaimer +```{admonition} Notice and Disclaimer +:class: warning + This software automatically retrieves, accesses or interacts with external materials. Those retrieved materials are not distributed with this software and are governed solely by separate terms, conditions and licenses. You are solely responsible for finding, reviewing and complying with all applicable terms, conditions, and licenses, and for verifying the security, integrity and suitability of any retrieved materials for your specific use case. This software is provided "AS IS", without warranty of any kind. The author makes no representations or warranties regarding any retrieved materials, and assumes no liability for any losses, damages, liabilities or legal consequences from your use or inability to use this software or any retrieved materials. Use this software and the retrieved materials at your own risk. ```