docs: update package description

trendmicro-frontend · Nov 27, 2024 · 45c3ba9 · 45c3ba9
1 parent 754d9f5
commit 45c3ba9
Show file tree

Hide file tree

Showing 24 changed files with 56 additions and 30 deletions.
diff --git a/packages/changelog-github/README.md b/packages/changelog-github/README.md
@@ -0,0 +1,3 @@
+# @tonic-ui/changelog-github
+
+A tool for generating changelogs with links to GitHub commits, PRs, and users.
diff --git a/packages/changelog-github/package.json b/packages/changelog-github/package.json
@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "@tonic-ui/changelog-github",
-  "description": "A changelog entry generator for GitHub that links to commits, PRs and users",
+  "description": "A tool for generating changelogs with links to GitHub commits, PRs, and users.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [

diff --git a/packages/codemod/README.md b/packages/codemod/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/codemod
 
-This repository contains a collection of codemod scripts based for use with [jscodeshift](https://github.com/facebook/jscodeshift) that help update the APIs.
+A set of codemod scripts designed to simplify the migration and updating of Tonic UI applications.
 
 ## Usage
 

diff --git a/packages/codemod/package.json b/packages/codemod/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/codemod",
   "version": "2.1.0",
-  "description": "Codemod scripts for Tonic UI",
+  "description": "A set of codemod scripts designed to simplify the migration and updating of Tonic UI applications.",
   "bin": "./codemod-cli.js",
   "files": [
     "codemod-cli.js",

diff --git a/packages/react-base/README.md b/packages/react-base/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/react-base
 
-A library of headless React UI components.
+Headless React components intended for creating custom UI elements.
 
 ## Installation
 

diff --git a/packages/react-base/package.json b/packages/react-base/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/react-base",
   "version": "2.0.1",
-  "description": "A library of headless React UI components.",
+  "description": "Headless React components intended for creating custom UI elements.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [

diff --git a/packages/react-docs/pages/components/index.page.mdx b/packages/react-docs/pages/components/index.page.mdx
@@ -1,6 +1,8 @@
+import pkg from '@tonic-ui/react/package.json';
+
 # React Components
 
-React Tonic UI component library.
+{pkg.description}
 
 ## Installation
 

diff --git a/packages/react-docs/pages/getting-started/installation/index.page.mdx b/packages/react-docs/pages/getting-started/installation/index.page.mdx
@@ -1,3 +1,13 @@
+import pkg_changelog_github from '@tonic-ui/changelog-github/package.json';
+import pkg_codemod from '@tonic-ui/codemod/package.json';
+import pkg_react from '@tonic-ui/react/package.json';
+import pkg_react_base from '@tonic-ui/react-base/package.json';
+import pkg_react_hooks from '@tonic-ui/react-hooks/package.json';
+import pkg_react_icons from '@tonic-ui/react-icons/package.json';
+import pkg_styled_system from '@tonic-ui/styled-system/package.json';
+import pkg_theme from '@tonic-ui/theme/package.json';
+import pkg_utils from '@tonic-ui/utils/package.json';
+
 # Installation
 
 Inside your React project directory, install React Tonic UI component library either using npm or yarn:
@@ -14,11 +24,14 @@ It will install all the dependencies for you.
 
 ## Packages
 
-| Name | Description | [GitHub](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages) | [NPM](https://www.npmjs.com/settings/tonic-ui/packages) | [Documentation](../getting-started) |
-| :--- | :---------- | :----------------------------------------------------------------------------- | :------------------------------------------------------ | :---------------------------------- |
-| `@tonic-ui/react` | React Tonic UI component library. | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react) | [View](https://www.npmjs.com/package/@tonic-ui/react) | [View](../components) |
-| `@tonic-ui/react-base` | A library of headless React UI components. | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react-base) | [View](https://www.npmjs.com/package/@tonic-ui/react-base) | [View](../base) |
-| `@tonic-ui/react-hooks` | A collection of React Hooks for Tonic UI components. | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react-hooks) | [View](https://www.npmjs.com/package/@tonic-ui/react-hooks) | [View](../hooks) |
-| `@tonic-ui/react-icons` | Tonic icons distributed as SVG React components. | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react-icons) | [View](https://www.npmjs.com/package/@tonic-ui/react-icons) | [View](../icons) |
-| `@tonic-ui/styled-system` | The framework agnostic styling engine for Tonic UI. | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/styled-system) | [View](https://www.npmjs.com/package/@tonic-ui/styled-system) | [View](../styled-system) |
-| `@tonic-ui/theme` | The default theme package for Tonic UI components. | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/theme) | [View](https://www.npmjs.com/package/@tonic-ui/theme) | [View](../theme) |
+| Name | Description | GitHub | NPM | Documentation |
+| :--- | :---------- | :----- | :-- | :------------ |
+| `@tonic-ui/changelog-github` | {pkg_changelog_github.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/changelog-github) | - | - |
+| `@tonic-ui/codemod` | {pkg_codemod.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/codemod) | [View](https://www.npmjs.com/package/@tonic-ui/codemod) | - |
+| `@tonic-ui/react` | {pkg_react.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react) | [View](https://www.npmjs.com/package/@tonic-ui/react) | [View](../components) |
+| `@tonic-ui/react-base` | {pkg_react_base.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react-base) | [View](https://www.npmjs.com/package/@tonic-ui/react-base) | - |
+| `@tonic-ui/react-hooks` | {pkg_react_hooks.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react-hooks) | [View](https://www.npmjs.com/package/@tonic-ui/react-hooks) | [View](../hooks) |
+| `@tonic-ui/react-icons` | {pkg_react_icons.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/react-icons) | [View](https://www.npmjs.com/package/@tonic-ui/react-icons) | [View](../icons) |
+| `@tonic-ui/styled-system` | {pkg_styled_system.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/styled-system) | [View](https://www.npmjs.com/package/@tonic-ui/styled-system) | [View](../styled-system) |
+| `@tonic-ui/theme` | {pkg_theme.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/theme) | [View](https://www.npmjs.com/package/@tonic-ui/theme) | [View](../theme) |
+| `@tonic-ui/utils` | {pkg_utils.description} | [View](https://github.com/trendmicro-frontend/tonic-ui/tree/master/packages/utils) | [View](https://www.npmjs.com/package/@tonic-ui/utils) | - |
diff --git a/packages/react-docs/pages/hooks/index.page.mdx b/packages/react-docs/pages/hooks/index.page.mdx
@@ -1,6 +1,8 @@
+import pkg from '@tonic-ui/react-hooks/package.json';
+
 # React Hooks
 
-A collection of React Hooks for Tonic UI components.
+{pkg.description}
 
 ## Installation
 

diff --git a/packages/react-docs/pages/icons/index.page.mdx b/packages/react-docs/pages/icons/index.page.mdx
@@ -1,6 +1,8 @@
+import pkg from '@tonic-ui/react-icons/package.json';
+
 # React Icons
 
-Tonic icons distributed as SVG React components.
+{pkg.description}
 
 ## Installation
 

diff --git a/packages/react-docs/pages/styled-system/index.page.mdx b/packages/react-docs/pages/styled-system/index.page.mdx
@@ -1,6 +1,8 @@
+import pkg from '@tonic-ui/styled-system/package.json';
+
 # Styled System
 
-The framework agnostic styling engine for Tonic UI.
+{pkg.description}
 
 ## Installation
 

diff --git a/packages/react-docs/pages/theme/index.page.mdx b/packages/react-docs/pages/theme/index.page.mdx
@@ -1,6 +1,8 @@
+import pkg from '@tonic-ui/theme/package.json';
+
 # Theme
 
-The default theme package for Tonic UI components.
+{pkg.description}
 
 ## Installation
 

diff --git a/packages/react-hooks/README.md b/packages/react-hooks/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/react-hooks
 
-A collection of React Hooks for Tonic UI components.
+A set of React Hooks specifically for use with Tonic UI components.
 
 ## Installation
 

diff --git a/packages/react-hooks/package.json b/packages/react-hooks/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/react-hooks",
   "version": "2.0.0",
-  "description": "A collection of React Hooks for Tonic UI components.",
+  "description": "A set of React Hooks specifically for use with Tonic UI components.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [

diff --git a/packages/react-icons/README.md b/packages/react-icons/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/react-icons
 
-Tonic icons distributed as SVG React components.
+A set of SVG icons available as React components for use in Tonic UI.
 
 ## Installation
 

diff --git a/packages/react-icons/package.json b/packages/react-icons/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/react-icons",
   "version": "2.1.0",
-  "description": "Tonic icons distributed as SVG React components.",
+  "description": "A set of SVG icons available as React components for use in Tonic UI.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [

diff --git a/packages/react/README.md b/packages/react/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/react
 
-React Tonic UI component library.
+A comprehensive React component library for Tonic UI.
 
 ## Installation
 

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/react",
   "version": "2.4.0",
-  "description": "React Tonic UI component library.",
+  "description": "A comprehensive React component library for Tonic UI.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [

diff --git a/packages/styled-system/README.md b/packages/styled-system/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/styled-system
 
-The framework agnostic styling engine for Tonic UI.
+A framework-independent styling engine for Tonic UI.
 
 ## Installation
 

diff --git a/packages/styled-system/package.json b/packages/styled-system/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/styled-system",
   "version": "2.0.2",
-  "description": "The framework agnostic styling engine for Tonic UI.",
+  "description": "A framework-independent styling engine for Tonic UI.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [

diff --git a/packages/theme/README.md b/packages/theme/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/theme
 
-The default theme package for Tonic UI components.
+The default theme configuration for Tonic UI components.
 
 ## Installation
 

diff --git a/packages/theme/package.json b/packages/theme/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/theme",
   "version": "2.0.0",
-  "description": "The default theme package for Tonic UI components.",
+  "description": "The default theme configuration for Tonic UI components.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [

diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -1,6 +1,6 @@
 # @tonic-ui/utils
 
-Common utilities for various Tonic UI components and packages.
+A set of utility functions shared across Tonic UI components and packages.
 
 ## Installation
 

diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@tonic-ui/utils",
   "version": "2.1.0",
-  "description": "Common utilities for various Tonic UI components and packages.",
+  "description": "A set of utility functions shared across Tonic UI components and packages.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "files": [
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# @tonic-ui/changelog-github

		A tool for generating changelogs with links to GitHub commits, PRs, and users.