feat(APP-3714): Rename ODS library to gov-ui-kit (#313)

.storybook/manager.ts

@@ -1,6 +1,6 @@
 import { addons } from '@storybook/manager-api';
-import aragonOdsTheme from './theme';
+import aragonGukTheme from './theme';
 
 addons.setConfig({
-    theme: aragonOdsTheme,
+    theme: aragonGukTheme,
 });

.storybook/preview.tsx

@@ -1,6 +1,6 @@
 import type { Preview } from '@storybook/react';
 import '../index.css';
-import { OdsModulesProvider } from '../src/modules';
+import { GukModulesProvider } from '../src/modules';
 import './style.css';
 
 const preview: Preview = {
@@ -31,19 +31,19 @@ const preview: Preview = {
             values: [
                 {
                     name: 'neutral-50',
-                    value: 'var(--ods-color-neutral-50)',
+                    value: 'var(--guk-color-neutral-50)',
                 },
             ],
         },
     },
 
     decorators: [
         (Story) => (
-            <OdsModulesProvider>
+            <GukModulesProvider>
                 <div className="flex">
                     <Story />
                 </div>
-            </OdsModulesProvider>
+            </GukModulesProvider>
         ),
     ],
 

.storybook/theme.ts

@@ -2,7 +2,7 @@ import { create } from '@storybook/theming';
 
 export default create({
     base: 'light',
-    brandTitle: 'Aragon ODS',
+    brandTitle: 'Aragon Governance UI Kit',
     brandUrl: 'https://aragon.org',
     brandImage: 'https://i.postimg.cc/RVVSGThD/logo.png',
     brandTarget: '_blank',

CHANGELOG.md

@@ -7,8 +7,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
-### Chhanged
+### Changed
 
+-   Convert ODS repo & package to Governance UI Kit brand name + docs
+-   Update name of `OdsCoreProvider` to `GukCoreProvider` to match new naming scheme
+-   Update name of `OdsModulesProvider` to `GukModulesProvider` to match new naming scheme
+-   Update all `--ods-*` CSS variables to `--guk-*` to match new naming scheme
 -   Bump `eslint-plugin-react-hooks` from 4.6.2 to 5.0.0
 -   Bump `secp256k1` from 5.0.0 to 5.0.1
 -   Update minor and patch NPM dependencies

README.md

@@ -12,25 +12,25 @@
 
 <br/>
 
-# Aragon ODS
+# Aragon Governance UI Kit 🎨
 
-The Aragon Open Design System (ODS) is an open source and human-centric design system specifically designed for the
+The Aragon Governance UI Kit (GovKit) is an open source and human-centric design system specifically designed for the
 Aragon App. It provides a unified and easy-to-use framework for creating visually consistent and engaging interfaces,
 prioritizing user experience throughout the Aragon ecosystem.
 
-**NOTE**: The Aragon ODS library is currently in pre-alpha stage; breaking changes are likely to occur.
+**NOTE**: The Aragon Governance UI Kit library is currently in pre-alpha stage; breaking changes are likely to occur.
 
-## Usage
+## Usage 📀
 
-Visit the [Installation documentation page](https://aragon.github.io/ods/?path=/docs/docs-installation) to correctly
-install, setup and use the library.
+Visit the [Installation documentation page](https://aragon.github.io/gov-ui-kit/?path=/docs/docs-installation) to
+correctly install, setup and use the library.
 
-## Contributing
+## Contributing 🏗️
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 Please make sure to update tests as appropriate.
 
-## License
+## License 📜
 
-[GPL-V3](./LICENSE)
+The Aragon Governance UI Kit is released under the [GPL-V3 License](./LICENSE).

docs/codingGuidelines/libraryDependencies.mdx

@@ -6,9 +6,9 @@ import { Meta } from '@storybook/blocks';
 
 ## Dependencies
 
-The `@aragon/ods` library relies on the dependencies listed under the `dependencies` section to function correctly.
-These dependencies are not bundled with the library, but when you add `@aragon/ods` to your application, the package
-manager will install them if they are missing in the current project.
+The `@aragon/gov-ui-kit` library relies on the dependencies listed under the `dependencies` section to function
+correctly. These dependencies are not bundled with the library, but when you add `@aragon/gov-ui-kit` to your
+application, the package manager will install them if they are missing in the current project.
 
 ## Peer Dependencies
 

docs/installation.mdx

@@ -4,24 +4,24 @@ import { Meta } from '@storybook/blocks';
 
 # Installation
 
-Install the `@aragon/ods` library and using Yarn or npm:
+Install the `@aragon/gov-ui-kit` library and using Yarn or npm:
 
-Yarn:
+yarn:
 
 ```shell
-yarn add @aragon/ods
+yarn add @aragon/gov-ui-kit
 ```
 
-Npm:
+npm:
 
 ```shell
-npm install @aragon/ods
+npm install @aragon/gov-ui-kit
 ```
 
 # Setup
 
-You can setup the Aragon ODS library in your project with [Taildwind CSS](https://tailwindcss.com) or as a standalone
-library:
+You can setup the Aragon Governance UI Kit library in your project with [Taildwind CSS](https://tailwindcss.com) or as a
+standalone library:
 
 -   Follow the [Setup with TailwindCSS](#setup-with-tailwindcss) guide if you are using or planning to use
     `Tailwind CSS` for your project.
@@ -48,32 +48,32 @@ library:
 
     ```javascript
     module.exports = {
-        presets: [require('@aragon/ods/tailwind.config')],
-        content: ['./src/**/*.{jsx,tsx,html}', './node_modules/@aragon/ods/**/*.js'],
+        presets: [require('@aragon/gov-ui-kit/tailwind.config')],
+        content: ['./src/**/*.{jsx,tsx,html}', './node_modules/@aragon/gov-ui-kit/**/*.js'],
     };
     ```
 
--   Import the Aragon ODS styles in your project entry file (e.g. `src/index.js` or `App.js`):
+-   Import the Aragon Governance UI Kit styles in your project entry file (e.g. `src/index.js` or `App.js`):
 
     ```typescript
-    import '@aragon/ods/index.css';
+    import '@aragon/gov-ui-kit/index.css';
     ```
 
 ## Standalone Setup
 
--   Import the Aragon ODS stylesheet bundle in your project entry file (e.g. `src/index.js` or `App.js`):
+-   Import the Aragon Governance UI Kit stylesheet bundle in your project entry file (e.g. `src/index.js` or `App.js`):
 
     ```typescript
-    import '@aragon/ods/build.css';
+    import '@aragon/gov-ui-kit/build.css';
     ```
 
 # Usage
 
-Import the `@aragon/ods` library on your application and start using the components:
+Import the `@aragon/gov-ui-kit` library on your application and start using the components:
 
 ```typescript
 import React from 'react';
-import { Button } from '@aragon/ods';
+import { Button } from '@aragon/gov-ui-kit';
 
 export const App: React.FC = () => (
     <div>

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@aragon/ods",
+  "name": "@aragon/gov-ui-kit",
   "version": "1.0.49",
-  "description": "Implementation of the Aragon's Open Design System",
+  "description": "Implementation of the Aragon's Governance UI Kit",
   "main": "dist/index.es.js",
   "types": "dist/types/src/index.d.ts",
   "license": "GPL-3.0",
@@ -31,12 +31,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/aragon/ods.git"
+    "url": "git+https://github.com/aragon/gov-ui-kit.git"
   },
   "keywords": [
     "aragon",
     "design-system",
-    "open-design-system",
+    "governance-ui-kit",
     "react",
     "tailwind"
   ],
@@ -148,9 +148,9 @@
     "wagmi": "^2.12.20"
   },
   "bugs": {
-    "url": "https://github.com/aragon/ods/issues"
+    "url": "https://github.com/aragon/gov-ui-kit/issues"
   },
-  "homepage": "https://github.com/aragon/ods#readme",
+  "homepage": "https://github.com/aragon/gov-ui-kit#readme",
   "engines": {
     "node": ">=20.0.0"
   },

src/core/assets/copy/coreCopy.ts

@@ -1,5 +1,5 @@
 /**
- * Object representing the structure of copy texts used in various parts of the ODS Core package.
+ * Object representing the structure of copy texts used in various parts of the GovKit Core package.
  * Each property in the object corresponds to a specific component or feature, containing the necessary
  * text labels or functions that return text strings.
  */