hypercerts schema and welcome page draft completed

Author: c-georgen

data-schemas/hypercerts.md

@@ -3,4 +3,79 @@ label: Hypercerts
 order: -1
 ---
 
-Change Code leverages the Hypercerts protocol, in turn developed from the ERC1155 token standard for semi-fungible tokens.
+Change Code leverages the Hypercerts protocol, in turn developed from the ERC1155 token standard for semi-fungible tokens. While adhering to the requirements of the standard, Change Code modifies *how* some of the schema fields are used, adapting them to our theory of change and implementation needs.
+
+## ERC1155 Fields
+
+Name | `CC Hypercert | {Good Generator} {Index}`
+:   The Hypercert name mirrors the name used for a project's IOUs. The concept of an index is again used to support single organizations working across multiple initiatives.   
+
+Description
+:   A description, not exceeding 200 characters, of the work to be done by the project.
+
+Image
+:   While the image field is required by the Hypercerts standard, we do not believe a single immutable image to be valuable for the purposes of serious impact validation. To satisfy this requirement, the Changescape backend will automatically generate and provide an image to satisfy the requirement.
+
+## Hypercert Dimensions
+
+work_scope
+:   A list of tasks to be done by the project. In development parlance this is a list of *outputs*--e.g. # of solar panels installed, kilos of supplies, $ of direct aid, # of vaccines.
+
+work_timeframe
+:   The time period during which the work for the project is to be carried out. In line with the Hypercerts standard, this is represented as an ordered pair of UTC timestamps.
+
+impact_scope
+:   Inside the Changescape `impact scope` is used to refer thematically to projects by category. For example, the [UN Sustainable Development Goals (SDGs)](https://sdgs.un.org/goals) or the [Ecological Benefits Framework (EBF)](https://ebfcommons.org/lex-icons/). Because the Hypercerts data is only aspirational, it would be premature to immutably publish indicators, which are instead reserved to be published only once verified inside Change Credits.
+
+impact_timeframe
+:   The time period during which impact *outcomes* will be measured and calculated. For Hypercerts inside the Changescape, the start time is set equal to the start time for the `work_timeframe` while the end time is set for the end of the work period plus five (5) years. Again this data is represented as an ordered pair of UTC timestamps.
+
+contributors
+:   A list of participants (organizations) that are contributing to the work done in the project. Each element in the list is composed of an on-chain address, a name, and a weight. The purpose of the weight is to signal relative contribution and may optionally be used to weight distributions among contributors.
+
+rights
+:   As of version 1.0 of the Hypercerts standard, this value can only be set to *public display*. As it is a required field, Change Code simply applies the default value but does not otherwise use this information.
+
+hidden_properties
+:   In development
+
+## Example Hypercert Dimensions
+
+```
+"hypercert": {
+    "work_scope": {
+        "name": "Work Scope",
+        "value": ["sustainable land management"],
+        "excludes": [],
+        "display_value": "sustainable land management"
+    },
+    "impact_scope": {
+        "name": "Impact Scope",
+        "value": [SDG 13], [SDG 15]
+        "excludes": [],
+        "display_value": "SDG 13 - Climate Action", "SDG 15 - Life on Land"
+    },    
+    "work_timeframe": {
+        "name": "Work Timeframe",
+        "value": [1704096000, 1735711200],
+        "display_value": "2024-01-01 -> 2024-12-31"
+    },
+    "impact_timeframe": {
+        "name": "Impact Timeframe",
+        "value": [1704096000, 1893477600],
+        "display_value": "2024-01-01 -> 2030-12-31"
+    },
+    "contributors": {
+        "name": "Contributors",
+        "value": ["0xa1fa1fa000000000000000000000000000000000", "Project Developer", 0.9], ["0xa1fa1fa000000000000000000000000000000000", "Carbon Standards Body", 0.1]
+        "display_value": "Project Developer", "Carbon Standards Body"
+    },
+    "rights": {
+        "name": "Rights",
+        "value": ["Public Display"],
+        "display_value": "Public Display"
+    }
+}
+```
+
+Additional details on the Hypercerts implementation itself can be found in the documentation [here](https://hypercerts.org/docs/implementation/metadata).

data-schemas/index.yml

@@ -1,4 +1,4 @@
-icon: code-of-conduct
+icon: ruby
 expanded: true
 order: -5
 label: Token Implementations and Data Schemas

retype.yml

@@ -4,9 +4,6 @@ url: docs.changecode.io
 branding:
   title: Change Code Knowledgebase
   label: Docs
-links:
-- text: Getting Started
-  link: https://retype.com/guides/getting-started/
 footer:
   copyright: "© Copyright {{ year }} Change Code, Inc. All rights reserved."
 

welcome.md

@@ -0,0 +1,12 @@
+---
+icon: rocket
+order: -1
+label: Welcome
+---
+Welcome to the Change Code Knowledgebase. At Change Code we're building the tools for individuals and organizations to attest to and verify their impact and package that data into a meaningfully representative impact asset. Ultimately, the goal of these assets is to provide an unrestricted, but still accountable revenue stream, reducing the cost of social enterprise and eventually removing the need for continuous and unpredictable outside funding. Change Code is creating financial and data primitives that reliably and scalably represent impact outputs and just as important, longer-term impact outcomes—pioneering token-based representations of consumable and capital impact assets.
+
+At the core of Change Code's work is our belief that in order to actualy achieve the world's sustainability and other impact goals, we must find a way to *make purpose profitable*. We are working to pioneer new financial primitives and tokenomics that will see impact itself emerge as the next asset class to be powered by web3.
+
+The *Changescape* is a multi-chain and multi-token dApp (decentralized application) engineered to support the tokenization, verification, and ultimate monetization of a new asset category, postive impact.
+
+If you're interested in contributing to our work, navigate over to the [Contributor Guide](./contributing/contribution-guide/).