From 2e8eab60f6e310b81c814a885552ee85bf11ad1c Mon Sep 17 00:00:00 2001
From: Dave Bort <dbort@meta.com>
Date: Wed, 16 Oct 2024 17:07:06 -0700
Subject: [PATCH] Add placeholder runtime/COMPATIBILITY.md (#6307)

Summary:
This file will contain the details of the PTE-to-runtime compatibility policy.

Update the appropriate docs to point to this file. Note that even release branches should point to the `main` branch version of this file, because the latest version is always the official policy.

Pull Request resolved: https://github.com/pytorch/executorch/pull/6307

Test Plan:
Checked links:
- https://docs-preview.pytorch.org/pytorch/executorch/6307/index.html
- https://docs-preview.pytorch.org/pytorch/executorch/6307/pte-file-format.html

Reviewed By: mergennachin

Differential Revision: D64501085

Pulled By: dbort

fbshipit-source-id: ac59529aa12fa76880a3531023a1a308f565ba50
(cherry picked from commit 6a27cd11e942d63495bc2e7997872ad7c16fb16b)
---
 docs/source/index.rst          | 15 ++++++++++-----
 docs/source/pte-file-format.md |  7 +++++++
 runtime/COMPATIBILITY.md       |  9 +++++++++
 3 files changed, 26 insertions(+), 5 deletions(-)
 create mode 100644 runtime/COMPATIBILITY.md

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 1e1060f70b..b8c72f8ee2 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -4,11 +4,16 @@ Welcome to the ExecuTorch Documentation
 =======================================
 
 .. important::
-   This is an alpha release; the ExecuTorch APIs and the ``.pte`` binary format
-   may change in incompatible ways before stabilizing in a future beta release.
-   When deploying models, we currently recommend using a version of the runtime
-   built from the same git revision that was used to generate the ``.pte`` file.
-   Once the format has stabilized, this will no longer be necessary.
+   v0.4.0 is a beta release of ExecuTorch. As of this release, the API will
+   follow the `API Lifecycle and Deprecation Policy <api-life-cycle.html>`__,
+   and the ``.pte`` binary format will comply with the `Runtime Compatibility
+   Policy
+   <https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md>`__.
+   This helps ensure that application developers can update to the latest
+   version of ExecuTorch without breaking existing integration code, in
+   accordance with these policies. If any issues arise or compatibility breaks
+   occur, please `report them in GitHub
+   <https://github.com/pytorch/executorch/issues/new/choose>`__.
 
    We welcome any feedback, suggestions, and bug reports from the community
    to help us improve the technology. Please use the `PyTorch Forums
diff --git a/docs/source/pte-file-format.md b/docs/source/pte-file-format.md
index 9917db9f82..9f5757ed25 100644
--- a/docs/source/pte-file-format.md
+++ b/docs/source/pte-file-format.md
@@ -31,6 +31,13 @@ Optional ─┤  ├────────────────────
           └─ └───────────────────────────────────┘
 ```
 
+## Compatibility
+
+See the [Runtime Compatibility Policy](
+https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md) for
+details about the compatibility guarantees between the `.pte` format and the
+ExecuTorch runtime.
+
 ## Headers
 
 Program files can be recognized by the magic string at byte offset 4, beginning
diff --git a/runtime/COMPATIBILITY.md b/runtime/COMPATIBILITY.md
new file mode 100644
index 0000000000..7dc46115bb
--- /dev/null
+++ b/runtime/COMPATIBILITY.md
@@ -0,0 +1,9 @@
+# Runtime Compatibility Policy
+
+This document will describe the compatibility guarantees between the [`.pte` file
+format](https://pytorch.org/executorch/stable/pte-file-format.html) and the
+ExecuTorch runtime.
+
+> [!IMPORTANT]
+> The [canonical version of this document](https://github.com/pytorch/executorch/tree/main/runtime/COMPATIBILITY.md)
+> is in the `main` branch of the `pytorch/executorch` GitHub repo.