docs: change alpha statement into banner, add disclaimer

[miyoungc]

Summary

Preview: https://nvidia.github.io/NemoClaw/pr-preview/pr-1209/

Related Issue

Changes

Type of Change

• Code change for a new feature, bug fix, or refactor.
• Code change with doc updates.
• Doc only. Prose changes without code sample modifications.
• Doc only. Includes code sample changes.

Testing

• npx prek run --all-files passes (or equivalently make check).
• npm test passes.
• make docs builds without warnings. (for doc-only changes)

Checklist

General

• I have read and followed the contributing guide.
• I have read and followed the style guide. (for doc-only changes)

Code Changes

• Formatters applied — npx prek run --all-files auto-fixes formatting (or make format for targeted runs).
• Tests added or updated for new or changed behavior.
• No secrets, API keys, or credentials committed.
• Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).

Doc Changes

• Follows the style guide. Try running the update-docs agent skill to draft changes while complying with the style guide. For example, prompt your agent with "/update-docs catch up the docs for the new changes I made in this PR."
• New pages include SPDX license header and frontmatter, if creating a new page.
• Cross-references and links verified.

---

Signed-off-by: Your Name your-email@example.com

Summary by CodeRabbit

• Documentation
  • Updated README and site docs with a new Notice & Disclaimer clarifying the software’s alpha status, advising against production use, and adding warranty and liability disclaimers.
  • Added a prominent announcement/warning on the docs homepage and release notes, removed the prior embedded alpha include, and noted that the software may access external materials subject to separate terms—users must verify suitability and compliance.

[coderabbitai]

📝 Walkthrough

Walkthrough

Replaced embedded alpha-statement includes with explicit disclaimer content and theme announcement entries: added a "Notice and Disclaimer" to README and docs pages, removed the _includes/alpha-statement.md include from several docs, and added an announcement HTML entry to Sphinx html_theme_options.

Changes

Cohort / File(s)	Summary
Top-level README & index README.md, docs/index.md	Added a "Notice and Disclaimer" admonition covering external-material access, user responsibility for compliance/security, "AS IS" warranty language, and liability disclaimers.
Removed alpha include fragments docs/_includes/alpha-statement.md, docs/about/overview.md, docs/about/release-notes.md	Deleted the embedded alpha-status include and its admonition content; removed {include} directives referencing the alpha statement.
Docs theme configuration docs/conf.py	Added an announcement entry to html_theme_options with an HTML-formatted alpha notice advising against production use.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through pages, nibbled old signs away,
A shiny notice now greets the day,
"Check licenses, use with care," I sing,
AS IS and beware—keep your audits in spring! 🥕✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main changes: removing the alpha statement includes and replacing them with a banner in docs/conf.py and a disclaimer in docs/index.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/small-updates

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

1-1: ⚠️ Potential issue | 🟠 Major

Add the required SPDX Markdown header at the top of this file.

This file currently starts at Line 1 with the H1, so it misses the required SPDX HTML comment header for Markdown sources.

Proposed fix

+<!--
+  SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+  SPDX-License-Identifier: Apache-2.0
+-->
+
 # 🦞 NVIDIA NemoClaw: Reference Stack for Running OpenClaw in OpenShell

As per coding guidelines, "Include SPDX license header at the top of every source file ... Use ... HTML comments for Markdown files."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 1, Add the required SPDX HTML comment header at the very
top of README.md (before the existing H1 line) by inserting the SPDX license
identifier comment (e.g., <!-- SPDX-License-Identifier: <LICENSE> -->) so the
Markdown file includes the mandated SPDX header; update the placeholder
<LICENSE> to the project's actual SPDX identifier to match the repository
license.

🧹 Nitpick comments (2)

docs/index.md (1)

193-193: Split the disclaimer into one sentence per line and rewrite passive phrasing.

Line 193 packs many sentences into one line and uses passive voice in multiple places (for example, “are governed” / “is provided”). Please keep one sentence per source line and switch to active voice where possible.

As per coding guidelines, "Every sentence must end with a period. One sentence per line in source" and "Active voice required. Flag passive constructions."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/index.md` at line 193, Split the long disclaimer paragraph into separate
sentences with one sentence per source line and convert passive constructions to
active voice; specifically, rewrite the disclaimer block (the disclaimer
paragraph that begins "This software automatically retrieves, accesses or
interacts with external materials.") so each sentence ends with a period and
stands on its own line, replace passive phrases like "are governed" and "is
provided" with active phrasing (e.g., "Separate terms govern those materials"
and "The author provides this software 'AS IS' without warranty"), and keep the
original meaning and legal content while enforcing one-sentence-per-line and
active-voice requirements.

docs/conf.py (1)

99-100: Remove emoji and routine bolding from the announcement copy.

The announcement text uses a bell emoji and <strong> emphasis for routine warning text. LLM pattern detected.

Proposed fix

-    "announcement": (
-        "&#x1F514; NemoClaw is <strong>alpha software</strong>. APIs and behavior"
-        " may change without notice. Do not use in production."
-    ),
+    "announcement": (
+        "NemoClaw is alpha software. APIs and behavior may change without notice. "
+        "Do not use in production."
+    ),

As per coding guidelines, "LLM-generated patterns ... Emoji in documentation prose" and "Unnecessary bold on routine instructions ... should be flagged."

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/conf.py` around lines 99 - 100, Update the announcement string that
currently includes a bell emoji and HTML <strong> tags so it reads as plain text
without emoji or markup; replace the concatenated string fragment "🔔 NemoClaw
is <strong>alpha software</strong>. APIs and behavior" " may change without
notice. Do not use in production." with a plain-text sentence like "NemoClaw is
alpha software. APIs and behavior may change without notice. Do not use in
production." so the literal in the module (the announcement constant/string in
docs/conf.py) contains no emoji or HTML emphasis.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@README.md`:
- Line 1: Add the required SPDX HTML comment header at the very top of README.md
(before the existing H1 line) by inserting the SPDX license identifier comment
(e.g., <!-- SPDX-License-Identifier: <LICENSE> -->) so the Markdown file
includes the mandated SPDX header; update the placeholder <LICENSE> to the
project's actual SPDX identifier to match the repository license.

---

Nitpick comments:
In `@docs/conf.py`:
- Around line 99-100: Update the announcement string that currently includes a
bell emoji and HTML <strong> tags so it reads as plain text without emoji or
markup; replace the concatenated string fragment "🔔 NemoClaw is <strong>alpha
software</strong>. APIs and behavior" " may change without notice. Do not use in
production." with a plain-text sentence like "NemoClaw is alpha software. APIs
and behavior may change without notice. Do not use in production." so the
literal in the module (the announcement constant/string in docs/conf.py)
contains no emoji or HTML emphasis.

In `@docs/index.md`:
- Line 193: Split the long disclaimer paragraph into separate sentences with one
sentence per source line and convert passive constructions to active voice;
specifically, rewrite the disclaimer block (the disclaimer paragraph that begins
"This software automatically retrieves, accesses or interacts with external
materials.") so each sentence ends with a period and stands on its own line,
replace passive phrases like "are governed" and "is provided" with active
phrasing (e.g., "Separate terms govern those materials" and "The author provides
this software 'AS IS' without warranty"), and keep the original meaning and
legal content while enforcing one-sentence-per-line and active-voice
requirements.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ec4f7e45-716a-4dc3-933d-3765fc51870b

📥 Commits

Reviewing files that changed from the base of the PR and between 75b8bb9 and 96a5c63.

📒 Files selected for processing (5)

• README.md
• docs/about/overview.md
• docs/about/release-notes.md
• docs/conf.py
• docs/index.md

💤 Files with no reviewable changes (2)

• docs/about/release-notes.md
• docs/about/overview.md