From ac774350b0411c0adb9c75ca68cd804fd80fc504 Mon Sep 17 00:00:00 2001
From: JessamyT <jessamy.taylor@gmail.com>
Date: Mon, 24 Mar 2025 14:23:21 -0700
Subject: [PATCH 1/2] DOCS-3672: Add config changes to changelog

---
 docs/dev/reference/changelog.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/docs/dev/reference/changelog.md b/docs/dev/reference/changelog.md
index b4a6f09a2e..6c6e42a8f4 100644
--- a/docs/dev/reference/changelog.md
+++ b/docs/dev/reference/changelog.md
@@ -47,6 +47,34 @@ The [hot data store](/manage/reference/processes/) allows you to access recent d
 
 {{% /changelog %}}
 
+{{% changelog color="changed" title="Config uses API instead of type and namespace" date="2025-03-25" %}}
+
+The JSON configuration for a resource now uses a field called `api` for the {{< glossary_tooltip term_id="api-namespace-triplet" text="API triplet" >}} instead of the now deprecated `type` and `namespace` fields.
+For example, instead of:
+
+```json
+{
+  "name": "my_board",
+  "namespace": "rdk",
+  "type": "board",
+  "model": "viam:nvidia:jetson"
+}
+```
+
+You should use:
+
+```json
+{
+  "name": "my_board",
+  "api": "rdk:component:board",
+  "model": "viam:nvidia:jetson"
+}
+```
+
+Reverse-compatibility is maintained for existing configurations.
+
+{{% /changelog %}}
+
 {{% changelog color="removed" title="Managed Processes" date="2025-02-01" %}}
 
 [Managed Processes](/manage/reference/processes/) are now deprecated and will be removed in a future version of `viam-server`.

From dcf7d6e364696bab34e1f15b95fafe3764df5240 Mon Sep 17 00:00:00 2001
From: Jessamy Taylor <75634662+JessamyT@users.noreply.github.com>
Date: Tue, 25 Mar 2025 10:49:55 -0700
Subject: [PATCH 2/2] Apply suggestions from code review

Co-authored-by: Naomi Pentrel <5212232+npentrel@users.noreply.github.com>
---
 docs/dev/reference/changelog.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/dev/reference/changelog.md b/docs/dev/reference/changelog.md
index 6c6e42a8f4..ce36a4a8dc 100644
--- a/docs/dev/reference/changelog.md
+++ b/docs/dev/reference/changelog.md
@@ -49,7 +49,7 @@ The [hot data store](/manage/reference/processes/) allows you to access recent d
 
 {{% changelog color="changed" title="Config uses API instead of type and namespace" date="2025-03-25" %}}
 
-The JSON configuration for a resource now uses a field called `api` for the {{< glossary_tooltip term_id="api-namespace-triplet" text="API triplet" >}} instead of the now deprecated `type` and `namespace` fields.
+The JSON configuration for a resource now uses a field called `api` for the {{< glossary_tooltip term_id="api-namespace-triplet" text="API triplet" >}} instead of the deprecated `type` and `namespace` fields.
 For example, instead of:
 
 ```json
@@ -71,7 +71,7 @@ You should use:
 }
 ```
 
-Reverse-compatibility is maintained for existing configurations.
+Backward compatibility is maintained for existing configurations.
 
 {{% /changelog %}}