From aefaa8ae9aba160c46085f1c601d4daa72cc871e Mon Sep 17 00:00:00 2001 From: apenzk Date: Fri, 17 Jan 2025 08:55:56 +0100 Subject: [PATCH 1/7] init --- MD/md-x/README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 MD/md-x/README.md diff --git a/MD/md-x/README.md b/MD/md-x/README.md new file mode 100644 index 00000000..4d5e8f0a --- /dev/null +++ b/MD/md-x/README.md @@ -0,0 +1,70 @@ +# MD-\: \ + +- **Description**: A single sentence description summarizing the items in the desiderata. +- **Authors**: [Author](mailto:author@email.com) + + + +## Overview + + + +## Desiderata + + + +# Changelog + + \ No newline at end of file From a9550c8920a2df3beb6cb5455e34e0ce43fda839 Mon Sep 17 00:00:00 2001 From: apenzk Date: Fri, 17 Jan 2025 11:21:57 +0100 Subject: [PATCH 2/7] add content --- MD/md-x/README.md | 68 ++++++++++++----------------------------------- 1 file changed, 17 insertions(+), 51 deletions(-) diff --git a/MD/md-x/README.md b/MD/md-x/README.md index 4d5e8f0a..1d807340 100644 --- a/MD/md-x/README.md +++ b/MD/md-x/README.md @@ -1,70 +1,36 @@ -# MD-\: \ +# MD-89: Define Move Stack and Movement SDK -- **Description**: A single sentence description summarizing the items in the desiderata. -- **Authors**: [Author](mailto:author@email.com) - - +- **Description**: Define the Move Stack and the Movement SDK to provide clear categorization of our software components and standardize language around the Movement technologies. +- **Authors**: Andreas Penzkofer ## Overview - +The Move Stack and Movement SDK are foundational components for Movement technologies, aimed at empowering developers with standardized tools, interfaces, and services for building, interacting with, and maintaining Movement Labs' networks and dApps. ## Desiderata - +**User Journey**: Developers are able to have an easy access to which category is relevant to them. -# Changelog +**Justification**: The Move Stack may be extensive and complex, so categorization is necessary. It will accelerate for developers to find their way within the stack. - \ No newline at end of file +## Changelog From 0dd905f671d1584c0b99c333f9f617e146253712 Mon Sep 17 00:00:00 2001 From: apenzk Date: Fri, 17 Jan 2025 11:23:10 +0100 Subject: [PATCH 3/7] add another desiderata --- MD/md-x/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/MD/md-x/README.md b/MD/md-x/README.md index 1d807340..e99c5f79 100644 --- a/MD/md-x/README.md +++ b/MD/md-x/README.md @@ -27,7 +27,13 @@ The Move Stack and Movement SDK are foundational components for Movement technol **Justification**: Categorization of Software components helps to provide consistent documentation and may aid in framing the documentation. It also provides a clear and consistent language for discussing Movement technologies. -### D3: Remove confusion between SDK and Stack +### D3: Vizualization of the Move Stack + +**User Journey**: Developers can easily understand the Move Stack and its components. + +**Justification**: Visualization of the Move Stack will help developers to understand the components and their relationships. + +### D4: Reduce confusion between SDK and Stack **User Journey**: Developers are able to understand what the SDK implies. From b57d3a759f83c700cd5495a6406f87f9a20eadb5 Mon Sep 17 00:00:00 2001 From: apenzk Date: Fri, 17 Jan 2025 11:23:30 +0100 Subject: [PATCH 4/7] change folder --- MD/md-89/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 MD/md-89/README.md diff --git a/MD/md-89/README.md b/MD/md-89/README.md new file mode 100644 index 00000000..e99c5f79 --- /dev/null +++ b/MD/md-89/README.md @@ -0,0 +1,42 @@ +# MD-89: Define Move Stack and Movement SDK + +- **Description**: Define the Move Stack and the Movement SDK to provide clear categorization of our software components and standardize language around the Movement technologies. +- **Authors**: Andreas Penzkofer + +## Overview + +The Move Stack and Movement SDK are foundational components for Movement technologies, aimed at empowering developers with standardized tools, interfaces, and services for building, interacting with, and maintaining Movement Labs' networks and dApps. + +## Desiderata + +### D1: Standardization of Development Stack + +**User Journey**: Developers can utilize a well-documented stack to build and maintain Movement Labs' networks and dApps. + +**Justification**: Ensures high quality of documentation. + +### D2: Create Categories for Move Stack components + +**User Journey**: Developers are able to have an easy access to which category is relevant to them. + +**Justification**: The Move Stack may be extensive and complex, so categorization is necessary. It will accelerate for developers to find their way within the stack. + +### D2: Categorization of Software Components + +**User Journey**: Software components are clearly categorized and associated with categories within the Move Stack. + +**Justification**: Categorization of Software components helps to provide consistent documentation and may aid in framing the documentation. It also provides a clear and consistent language for discussing Movement technologies. + +### D3: Vizualization of the Move Stack + +**User Journey**: Developers can easily understand the Move Stack and its components. + +**Justification**: Visualization of the Move Stack will help developers to understand the components and their relationships. + +### D4: Reduce confusion between SDK and Stack + +**User Journey**: Developers are able to understand what the SDK implies. + +**Justification**: There has been much confusion about what the SDK constitutes. There is great need for clarification to align language in the ecosystem. + +## Changelog From 5029438a991e27b1dc8d4e2bb37c1e32da06784c Mon Sep 17 00:00:00 2001 From: apenzk Date: Fri, 17 Jan 2025 11:23:46 +0100 Subject: [PATCH 5/7] file removal --- MD/md-x/README.md | 42 ------------------------------------------ 1 file changed, 42 deletions(-) delete mode 100644 MD/md-x/README.md diff --git a/MD/md-x/README.md b/MD/md-x/README.md deleted file mode 100644 index e99c5f79..00000000 --- a/MD/md-x/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# MD-89: Define Move Stack and Movement SDK - -- **Description**: Define the Move Stack and the Movement SDK to provide clear categorization of our software components and standardize language around the Movement technologies. -- **Authors**: Andreas Penzkofer - -## Overview - -The Move Stack and Movement SDK are foundational components for Movement technologies, aimed at empowering developers with standardized tools, interfaces, and services for building, interacting with, and maintaining Movement Labs' networks and dApps. - -## Desiderata - -### D1: Standardization of Development Stack - -**User Journey**: Developers can utilize a well-documented stack to build and maintain Movement Labs' networks and dApps. - -**Justification**: Ensures high quality of documentation. - -### D2: Create Categories for Move Stack components - -**User Journey**: Developers are able to have an easy access to which category is relevant to them. - -**Justification**: The Move Stack may be extensive and complex, so categorization is necessary. It will accelerate for developers to find their way within the stack. - -### D2: Categorization of Software Components - -**User Journey**: Software components are clearly categorized and associated with categories within the Move Stack. - -**Justification**: Categorization of Software components helps to provide consistent documentation and may aid in framing the documentation. It also provides a clear and consistent language for discussing Movement technologies. - -### D3: Vizualization of the Move Stack - -**User Journey**: Developers can easily understand the Move Stack and its components. - -**Justification**: Visualization of the Move Stack will help developers to understand the components and their relationships. - -### D4: Reduce confusion between SDK and Stack - -**User Journey**: Developers are able to understand what the SDK implies. - -**Justification**: There has been much confusion about what the SDK constitutes. There is great need for clarification to align language in the ecosystem. - -## Changelog From 773ecd9f6563fab8457158a638b0416d2ee041e4 Mon Sep 17 00:00:00 2001 From: apenzk Date: Fri, 17 Jan 2025 11:24:19 +0100 Subject: [PATCH 6/7] codeowners --- .github/CODEOWNERS | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 33eddf40..7818f71b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -13,3 +13,4 @@ /MIP/mip-39/ @franck44 /MIP/mip-53/ @l-monninger /MIP/mip-58/ @primata @apenzk +/MIP/mip-89/ @apenzk From 684ef621ef6c1d7c3ae540b53dc2eb84a82e2343 Mon Sep 17 00:00:00 2001 From: apenzk Date: Fri, 17 Jan 2025 11:28:07 +0100 Subject: [PATCH 7/7] update MD number --- .github/CODEOWNERS | 2 +- MD/{md-89 => md-91}/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename MD/{md-89 => md-91}/README.md (97%) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 7818f71b..5e7b1385 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -13,4 +13,4 @@ /MIP/mip-39/ @franck44 /MIP/mip-53/ @l-monninger /MIP/mip-58/ @primata @apenzk -/MIP/mip-89/ @apenzk +/MIP/mip-91/ @apenzk diff --git a/MD/md-89/README.md b/MD/md-91/README.md similarity index 97% rename from MD/md-89/README.md rename to MD/md-91/README.md index e99c5f79..407da746 100644 --- a/MD/md-89/README.md +++ b/MD/md-91/README.md @@ -1,4 +1,4 @@ -# MD-89: Define Move Stack and Movement SDK +# MD-91: Define Move Stack and Movement SDK - **Description**: Define the Move Stack and the Movement SDK to provide clear categorization of our software components and standardize language around the Movement technologies. - **Authors**: Andreas Penzkofer