docs: ✏️ Update docs to new site

jsverse · Jan 4, 2025 · f6bee1d · f6bee1d
1 parent 0b3fa79
commit f6bee1d
Show file tree

Hide file tree

Showing 11 changed files with 87 additions and 64 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -44,22 +44,41 @@ Run the playground app:
 npm start
 ```
 
-## Building
+## Contributing to the Documentation
 
-```bash
-npm run build [package]
-```
+The Transloco documentation is hosted on GitBook and managed in the `gitbook-docs` branch.
+
+### Steps to Contribute:
+
+1. **Ensure you are working with the `gitbook-docs`**
+
+2. **Install Dependencies**  
+   Run the following commands to install the required dependencies:
+
+   ```bash
+   npm i
+   yarn
+   ```
+
+3. **Make Your Changes**  
+   Edit or add documentation files located in the `gitbook-docs` branch.
+
+4. **Preview Your Changes**  
+   Use GitBook CLI or relevant tools to preview the documentation locally if needed.
+
+5. **Submit a Pull Request**  
+   Once your changes are complete, push your branch and open a PR to the `gitbook-docs` branch. Make sure to clearly describe the changes in the PR description.
 
-Note: Don't use nx directly as some apps might have further building steps
+We welcome contributions that improve clarity, fix typos, add examples, or enhance the existing content!
 
-## <a name="rules"></a> Coding Rules
+## Coding Rules
 
 To ensure consistency throughout the source code, keep these rules in mind as you are working:
 
 - All features or bug fixes **must be tested** by one or more specs (unit-tests).
 - All public API methods **must be documented**.
 
-## <a name="commit"></a> Commit Message Guidelines
+## Commit Message Guidelines
 
 We have very precise rules over how our git commit messages can be formatted. This leads to **more
 readable messages** that are easy to follow when looking through the **project history**. But also,
@@ -74,7 +93,6 @@ npm run commit
 yarn commit
 ```
 
-Choose the correct package you are making the changes for, if this is a repository level change
-you can choose the first (empty) option.
+Choose the correct package you are making the changes for. If this is a repository-level change, you can choose the first (empty) option.
 
-**Important:** Only put something in the `BREAKING CHANGES` prompt if you actually made a breaking change, no need ot answer it with "no".
+**Important:** Only put something in the `BREAKING CHANGES` prompt if you actually made a breaking change; no need to answer it with "no."
diff --git a/README.md b/README.md
@@ -10,36 +10,37 @@
   The internationalization (i18n) library for Angular
 </p>
 
-<h2></h2>
+<h3></h3>
 
-Transloco allows you to define translations for your content in different languages and switch between them easily in runtime.
-It exposes a rich API to manage translations efficiently and cleanly. It provides multiple plugins that will improve your development experience. Here is a small taste of the features it offers:
+![npm](https://img.shields.io/npm/v/@jsverse/transloco)
+![Bundle Size](https://img.shields.io/bundlephobia/min/@jsverse/transloco)
+![Downloads](https://img.shields.io/npm/dm/@jsverse/transloco)
+[![Build Status](https://github.com/jsverse/transloco/actions/workflows/ci.yml/badge.svg)]()
+[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/jsverse/transloco/blob/master/CONTRIBUTING.md)
+
+Transloco enables you to define translations for your content in multiple languages and seamlessly switch between them at runtime. With its robust API, managing translations becomes efficient and maintainable. Additionally, Transloco offers an array of plugins designed to enhance your development experience. Here's a quick look at its powerful features:
 
 ✅ &nbsp;Clean and DRY templates  
-✅ &nbsp;Support for Lazy Load  
-✅ &nbsp;Support for Multiple Languages Simultaneously  
-✅ &nbsp;Support for Multiple Fallbacks  
-✅ &nbsp;Support for Testing  
-✅ &nbsp;Support for SSR  
-✅ &nbsp;Support for L10N  
-✅ &nbsp;Rich Plugins  
-✅ &nbsp;Hackable  
+✅ &nbsp;Lazy Loading support  
+✅ &nbsp;Handle multiple languages simultaneously  
+✅ &nbsp;Flexible fallbacks for missing translations  
+✅ &nbsp;Comprehensive testing support  
+✅ &nbsp;Server-Side Rendering (SSR) compatibility  
+✅ &nbsp;Localization (L10N) support  
+✅ &nbsp;A variety of rich plugins  
+✅ &nbsp;Highly customizable and hackable  
 ✅ &nbsp;Schematics  
-✅ &nbsp;Standalone support
+✅ &nbsp;Fully supports standalone components
+
+Transloco is your all-in-one solution for internationalizing Angular applications with ease and flexibility.
 
 <hr />
 
-[![Build Status](https://github.com/jsverse/transloco/actions/workflows/ci.yml/badge.svg)]()
-[![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)]()
-[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)]()
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e5079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
-
-- 🤓 &nbsp;Learn about it on the [docs site](https://jsverse.github.io/transloco/)
-- 🚀 &nbsp;See it in action on [CodeSandbox](https://codesandbox.io/s/jsverse-transloco-kn52hs)
-- 😎 &nbsp;Use [schematics](https://jsverse.github.io/transloco/docs/schematics)
-- 👉 &nbsp;Checkout the [live application](https://jsverse.github.io/transloco/live-app)
-- 📖 &nbsp;Read the blog [posts](https://jsverse.github.io/transloco/docs/blog-posts)
-- ❓ &nbsp;Find answers in our [FAQ](https://jsverse.github.io/transloco/docs/faq) section
+- 🤓 &nbsp;Explore the (brand new ✨) [documentation](https://jsverse.gitbook.io/transloco) to learn more.
+- 🚀 &nbsp;Check out the [Sandbox & Examples](https://jsverse.gitbook.io/transloco) to see Transloco in action.
+- 😎 &nbsp;Leverage [Schematics](https://jsverse.gitbook.io/transloco/schematics) for streamlined setup and configuration.
+- 📖 &nbsp;Dive into insightful [blog posts](https://jsverse.gitbook.io/transloco/blog-posts).
+- ❓ &nbsp;Find answers to common questions in our [FAQs](https://jsverse.gitbook.io/transloco/faqs).
 
 ## Contributors ✨
 

diff --git a/libs/transloco-locale/README.md b/libs/transloco-locale/README.md
@@ -1,3 +1,3 @@
 # Transloco Locale L10N
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/plugins/locale).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/plugins/locale-l10n).
diff --git a/libs/transloco-messageformat/README.md b/libs/transloco-messageformat/README.md
@@ -1,3 +1,3 @@
 # Transloco MessageFormat
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/plugins/message-format).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/plugins/message-format).
diff --git a/libs/transloco-optimize/README.md b/libs/transloco-optimize/README.md
@@ -1,3 +1,3 @@
 # Transloco Optimize
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/tools/optimize).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/tools/optimize).
diff --git a/libs/transloco-persist-lang/README.md b/libs/transloco-persist-lang/README.md
@@ -1,3 +1,3 @@
 # Transloco Persist Language
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/plugins/persist-lang).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/plugins/persist-lang).
diff --git a/libs/transloco-persist-translations/README.md b/libs/transloco-persist-translations/README.md
@@ -1,3 +1,3 @@
 # Transloco Persist Translations
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/plugins/persist-translations).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/plugins/persist-translations).
diff --git a/libs/transloco-preload-langs/README.md b/libs/transloco-preload-langs/README.md
@@ -1,3 +1,3 @@
 # Transloco Preload Languages
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/plugins/preload-langs).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/plugins/preload-langs).
diff --git a/libs/transloco-scoped-libs/README.md b/libs/transloco-scoped-libs/README.md
@@ -1,3 +1,3 @@
 # Transloco Scoped Libs
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/tools/scope-lib-extractor).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/tools/scoped-library-extractor).
diff --git a/libs/transloco-validator/README.md b/libs/transloco-validator/README.md
@@ -1,3 +1,3 @@
 # Transloco Validator
 
-Please visit the [official Transloco docs](https://jsverse.github.io/transloco/docs/tools/validator).
+Discover more about this plugin and how it can enhance your workflow in the [official Transloco documentation](https://jsverse.gitbook.io/transloco/tools/validator).
diff --git a/libs/transloco/README.md b/libs/transloco/README.md
@@ -1,3 +1,6 @@
+> [!IMPORTANT]  
+> The Transloco packages are now published under the **@jsverse** scope, update your dependencies to get the latest features 🚀
+
 <br />
 <p align="center">
  <img width="50%" height="50%" src="./logo.svg">
@@ -7,36 +10,37 @@
   The internationalization (i18n) library for Angular
 </p>
 
-<h2></h2>
+<h3></h3>
+
+![npm](https://img.shields.io/npm/v/@jsverse/transloco)
+![Bundle Size](https://img.shields.io/bundlephobia/min/@jsverse/transloco)
+![Downloads](https://img.shields.io/npm/dm/@jsverse/transloco)
+[![Build Status](https://github.com/jsverse/transloco/actions/workflows/ci.yml/badge.svg)]()
+[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/jsverse/transloco/blob/master/CONTRIBUTING.md)
 
-Transloco allows you to define translations for your content in different languages and switch between them easily in runtime.
-It exposes a rich API to manage translations efficiently and cleanly. It provides multiple plugins that will improve your development experience. Here is a small taste of the features it offers:
+Transloco enables you to define translations for your content in multiple languages and seamlessly switch between them at runtime. With its robust API, managing translations becomes efficient and maintainable. Additionally, Transloco offers an array of plugins designed to enhance your development experience. Here's a quick look at its powerful features:
 
 ✅ &nbsp;Clean and DRY templates  
-✅ &nbsp;Support for Lazy Load  
-✅ &nbsp;Support for Multiple Languages Simultaneously  
-✅ &nbsp;Support for Multiple Fallbacks  
-✅ &nbsp;Support for Testing  
-✅ &nbsp;Support for SSR  
-✅ &nbsp;Support for L10N  
-✅ &nbsp;Rich Plugins  
-✅ &nbsp;Hackable  
+✅ &nbsp;Lazy Loading support  
+✅ &nbsp;Handle multiple languages simultaneously  
+✅ &nbsp;Flexible fallbacks for missing translations  
+✅ &nbsp;Comprehensive testing support  
+✅ &nbsp;Server-Side Rendering (SSR) compatibility  
+✅ &nbsp;Localization (L10N) support  
+✅ &nbsp;A variety of rich plugins  
+✅ &nbsp;Highly customizable and hackable  
 ✅ &nbsp;Schematics  
-✅ &nbsp;Standalone support
+✅ &nbsp;Fully supports standalone components
+
+Transloco is your all-in-one solution for internationalizing Angular applications with ease and flexibility.
 
 <hr />
 
-[![Build Status](https://github.com/jsverse/transloco/actions/workflows/ci.yml/badge.svg)]()
-[![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)]()
-[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)]()
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e5079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
-
-- 🤓 &nbsp;Learn about it on the [docs site](https://jsverse.github.io/transloco/)
-- 🚀 &nbsp;See it in action on [CodeSandbox](https://codesandbox.io/s/jsverse-transloco-kn52hs)
-- 😎 &nbsp;Use [schematics](https://jsverse.github.io/transloco/docs/schematics)
-- 👉 &nbsp;Checkout the [live application](https://jsverse.github.io/transloco/live-app)
-- 📖 &nbsp;Read the blog [posts](https://jsverse.github.io/transloco/docs/blog-posts)
-- ❓ &nbsp;Find answers in our [FAQ](https://jsverse.github.io/transloco/docs/faq) section
+- 🤓 &nbsp;Explore the (brand new ✨) [documentation](https://jsverse.gitbook.io/transloco) to learn more.
+- 🚀 &nbsp;Check out the [Sandbox & Examples](https://jsverse.gitbook.io/transloco) to see Transloco in action.
+- 😎 &nbsp;Leverage [Schematics](https://jsverse.gitbook.io/transloco/schematics) for streamlined setup and configuration.
+- 📖 &nbsp;Dive into insightful [blog posts](https://jsverse.gitbook.io/transloco/blog-posts).
+- ❓ &nbsp;Find answers to common questions in our [FAQs](https://jsverse.gitbook.io/transloco/faqs).
 
 ## Contributors ✨