fix: Rename the existing UCR to not have leading sequence number (edg…

…exfoundry#837) * fix: Rename the existing UCR to not have leading sequence number Also added notes to TOC on naming and order of UCRs and ADRs Signed-off-by: Leonard Goodell <[email protected]>
TomBrennan-Eaton · Aug 23, 2022 · 18987ca · 18987ca
1 parent 2c40de6
commit 18987ca
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs_src/design/TOC.md b/docs_src/design/TOC.md
@@ -1,13 +1,20 @@
 # Use Cases and Design Records
 
 ## Use Case Records (UCRs)
+
+!!! note 
+    UCRs are listed in alphabetical order by title.
+
 | Name/Link                                                                 | Short Description                                             |
 |---------------------------------------------------------------------------|---------------------------------------------------------------|
 | [Provision Watch via Device Metadata](./ucr/Provision-Watch-via-Device-Metadata.md) | Use Case for Provision Watching via Additional Device Metadata |
 | [System Events for Devices](./ucr/System-Events-for-Devices.md) | Use Case for System Events for Device add/update/delete |
 
 ## Architectural Design Records (ADRs)
 
+!!! note
+    ADRs are listed in chronological order by sequence number in title.
+
 | Name/Link                                                    | Short Description                                            |
 | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | [0001 Registry Refactor](./adr/0001-Registy-Refactor.md)     | Separate out Registry and Configuration APIs                 |

diff --git a/...ign/ucr/0001-System-Events-for-Devices.md → ...c/design/ucr/System-Events-for-Devices.md b/...ign/ucr/0001-System-Events-for-Devices.md → ...c/design/ucr/System-Events-for-Devices.md