diff --git a/GLOSSARY.md b/GLOSSARY.md index 65699e69..f891618c 100644 --- a/GLOSSARY.md +++ b/GLOSSARY.md @@ -1,15 +1,3 @@ -## Glossary +# Glossary -Alphabetically ordered list of terms defined through MGs. - -**\$L1MOVE** -ERC-20 type token for the Movement Network with the source contract on L1. See also \$MOVE. > [MG-39](./MG/mg-39/README.md) - -**\$L2MOVE** -wrapped version of the \$L1MOVE token. > [MG-39](./MG/mg-39/README.md) - -**\$MOVE** -ERC-20 type token for the Movement Network with the source contract on L1. See also \$L1MOVE. > [MG-39](./MG/mg-39/README.md) - -**Native Bridge** -The bridge that allows the transfer of tokens between L1 and L2, which hold \$L1MOVE and \$L2MOVE token, respectively. The native bridge has the capability to mint \$L2MOVE tokens. > [MG-39](./MG/mg-39/README.md) +This document has been transferred to the [Glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary) on the Movement Labs GitHub Wiki. diff --git a/MG/mg-0/README.md b/MG/mg-0/README.md index 884b288b..02a81457 100644 --- a/MG/mg-0/README.md +++ b/MG/mg-0/README.md @@ -1,9 +1,13 @@ # MG-0: Gloss Example - **Authors**: [Liam Monninger](liam@movementlabs.xyz) - +- **Introducing Document: [MIP-0](../../MIP/mip-0/README.md)** A short description of a term as would feature as an entry in a glossary. +## Gloss + +A **gloss** is a short description of a term as would feature as an entry in a glossary. + ### Related Work 1. [Merriam-Webster's Definition of "gloss"](https://www.merriam-webster.com/dictionary/gloss) @@ -13,3 +17,5 @@ A short description of a term as would feature as an entry in a glossary. 1. He updated the **gloss** to include a more detailed explanation. ### Changelog + +2025-01-15: Updated the **gloss** to include a more detailed explanation. [#45](https://github.com/movementlabsxyz/MIP/pull/45) diff --git a/MIP/mip-15/README.md b/MIP/mip-15/README.md index 6c56cd88..600274ce 100644 --- a/MIP/mip-15/README.md +++ b/MIP/mip-15/README.md @@ -1,45 +1,71 @@ # MIP-15: MG (Movement Gloss) -- **Description**: Introduces the Movement Gloss (MG) document type and establishes a process for introducing new glossary terms. Introduces the [Glossary](../GLOSSARY.md), which contains an overview of all terms defined through MGs. +- **Description**: Terms should be well defined. This is achieved through the [Glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary) and the Movement Gloss (MG) process. - **Authors**: [Liam Monninger](mailto:liam@movementlabs.xyz) - **Reviewer**: Andreas Penzkofer -- **Desiderata**: [MD-15](../MD/md-15/README.md) +- **Desiderata**: [MD-15](../../MD/md-15/README.md) ## Abstract -This MIP introduces the Movement Gloss (MG) document type and establishes a process for introducing new glossary terms. The MG document type will be used to define terms unique to Movement Labs and to provide specific definitions for terms that are used in a unique way, underspecified in the literature, or have a specific meaning in the context of Movement Labs. +This MIP defines the [Glossary](../GLOSSARY.md), which contains an overview of relevant terms used in this repo. This glossary defines terms that are frequently used. + +Furthermore, this MIP introduces the Movement Gloss (MG) document type and establishes a process for introducing new glossary terms. The MG document type will be used to define terms unique to Movement Labs and to provide specific definitions for terms that are used in a unique way, underspecified in the literature, or have a specific meaning in the context of Movement Labs. ## Motivation -In order to communicate with more specificity in all contexts, Movement Labs should introduce a glossary. This glossary should define terms both unique to Movement Labs and general terms that are used in a unique way, underspecified in the literature, or have a specific meaning in the context of Movement Labs. +In order to communicate with more specificity in all contexts, Movement Labs should introduce a glossary. We require alignment of terms across this repository and beyond. + +Furthermore, terms may be underspecified in literature, are used in a unique way, or have a specific meaning in the context of Movement Labs. These terms may require additional extensive definition. This necessitates the introduction of the Movement Gloss (MG) document type. ## Specification -The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174. +> _The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174._ ### Glossary -The [Glossary](../GLOSSARY.md) is an alphabetically ordered list of terms defined through MGs. Any term introduced through an MG MUST be declared in the Glossary. +The [Glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary) is an alphabetically ordered list of terms that should be defined and may be frequently referenced. The glossary should be a living document that is updated as new terms are introduced or as terms are redefined. -The Glossary table contains the following columns: +The Glossary file contains: - The Term - A short definition -- The number of the MG that introduces the term +- (Optional) The number of the MG/MIP/MD that introduces the term. + +The format is as follows: + +```markdown +**** + → [MD-x](MD/md-x/README.md), [MG-y](MG/mg-y/README.md) +``` + +### MG (Movement Gloss) -### MG Document Type +An MG is a definition of a term that requires detailed explanation. Any term introduced through an MG MUST be declared in the Glossary. -A template for the MG is provided at [mg-template](../../md-template.md). An example MG is provided at [mg-0](../../MG/mg-0/README.md). These templates cover the requested elements listed in [MD-15.D1](../MD/md-15/README.md). +A template for the MG is provided at [mg-template](../../md-template.md). The template covers the requested elements listed in [MD-15.D1](../../MD/md-15/README.md). -### MG Process +An example MG is provided at [mg-0](../../MG/mg-0/README.md). -1. A new glossary term MUST be defined in an MG document matching the provided templates. -2. An MG document MUST not be accepted unless justified in an MIP. +An MG document MUST not be accepted unless it is required by an MIP or MD. For example, herein, we justify the introduction of [MG-0](../../MG/mg-0/README.md). MG-0 defines the term "gloss" which is used in the context of Movement Labs to denote the definition of a term as would feature as an entry in a glossary. For the MGs, it is important to include in the glossary both clarify as the acronym "MG" and to provide an example gloss. -For example, herein, we justify the introduction of [MG-0](../../MG/mg-0/README.md). MG-0 defines the term "gloss" which is used in the context of Movement Labs to denote the definition of a term as would feature as an entry in a glossary. It is important to include in the glossary both clarify as the acronym "MG" and to provide an example gloss. +#### MG Structure + +**Term** +Definition of the term. + +**Related Work** +Enumerate key usages of the term or related terms in other contexts. + +**Example Usages** +Provide examples of the term's usage in context. + +**Changelog** +Document any post-publication changes to the glossary entry. ## Reference Implementation +See the [Glossary](../../GLOSSARY.md). + See the MG document type template at [mg-template](../../md-template.md) and the example MG at [mg-0](../../MG/mg-0/README.md). ## Verification diff --git a/README.md b/README.md index 355557ba..5f1c16b6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # MIP, MD and MG -We differentiate between issues, MD and MIPs. +We differentiate between **issue**, **MD** and **MIP**. An overview of the MIPs and MDs can be found in the [OVERVIEW](https://movementlabsxyz.github.io/MIP/). @@ -16,7 +16,8 @@ graph LR A[Idea: issue] --> B[Request: MD] --> C[Solution: MIP] ``` -In addition MG serves as a glossary for terms defined in the MIPs and MDs. +The [Glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary) contains an alphabetically ordered list of terms used in this repository. +In addition MG serves as a platform to define glossary terms, which are used in the MIPs and MDs. !!! info For more information on the process in this repository, see also[MIP-0](./MIP/mip-0/README.md). @@ -50,14 +51,16 @@ You **SHOULD NOT** draft an MIP, if any of the following are true: - You only intend to request a change to software units or processes without overseeing specification and review. - The change is trivial. In the event that an MIP is required by governance, such trivial changes usually be handled as either errata or appendices of an existing MIP. -## Movement Glossary (MG) +## Glossary and Movement Gloss (MG) A template with instructions is provided at [mg-template](mg-template.md). See [MIP-15](./MIP/mip-15) for a definition of its functionality. See [MG-0](./MG/mg-0) for an example. -An alphabetically ordered list of terms is provided in the [glossary](GLOSSARY.md). +An alphabetically ordered list of terms is provided in the [glossary](https://github.com/movementlabsxyz/MIP/wiki/glossary). MGs serve to capture the **definitions** of terms introduced in the MIPs and MDs. The creation of a new MG requires an MIP or MG (since new terms are introduced through the MIP or MG). +See [MG-0](./MG/mg-0) for an example to get started. A template is provided at [mg-template](mg-template.md). + ## Files and numbering Each MIP, MD or MG is stored in a separate subdirectory with a name `mip-`, `md-` or `mg-`. The subdirectory contains a `README.md` that describes the MIP, MD, or MG. All assets related to the MIP, MD or MG are stored in the same subdirectory. diff --git a/mg-template.md b/mg-template.md index ed2d596b..2f101390 100644 --- a/mg-template.md +++ b/mg-template.md @@ -1,6 +1,9 @@ # MG-\: \ - **Authors**: [Author](mailto:author@email.com) +- **Introducing Document: [MIP/MD-\](../MIP/mip-\/README.md)** + +## \ \ No newline at end of file +-->