Added a "why Retype" page

gsoft-inc · Sep 25, 2023 · ef6a108 · ef6a108
1 parent 16ab0c1
commit ef6a108
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 5 deletions.
diff --git a/docs/backend/index.yaml b/docs/backend/index.yaml
@@ -1,3 +1,3 @@
-order: 70
+order: 90
 expanded: true
 icon: note
diff --git a/docs/default.md b/docs/default.md
@@ -2,7 +2,7 @@
 layout: page
 ---
 
-# Workleap Internal Developer Platform (IDP) Libraries
+# Workleap Internal Developer Platform (IDP)
 
 Welcome to the documentation hub for Workleap IDP libraries. On this site, you'll discover a variety of libraries that collectively constitutes the internal developer platform for creating applications on the Workleap platform.
 

diff --git a/docs/frontend/index.yaml b/docs/frontend/index.yaml
@@ -1,3 +1,3 @@
-order: 80
+order: 100
 expanded: true
 icon: browser
diff --git a/docs/joining-the-hub.md b/docs/joining-the-hub.md
@@ -1,5 +1,5 @@
 ---
-order: 100
+order: 80
 icon: rocket
 label: "Joining the hub"
 ---

diff --git a/docs/static/workleap-bg.png b/docs/static/workleap-bg.png
diff --git a/docs/why-retype.md b/docs/why-retype.md
@@ -1,8 +1,33 @@
 ---
-order: 90
+order: 70
 label: "Why Retype"
 icon: question
 ---
 
 # Why Retype over GitHub readme
 
+While GitHub `README.md` files are great, there are a few advantages to use a documentation platform like Retype:
+
+1. **Better Structuring:** Retype simplifies the organization of documentation by allowing easy division into multiple files and provides an intuitive navigation system with a left sidebar for seamless browsing.
+
+2. **Automatic Table of Contents:** Retype generates an in-page Table of Contents automatically from the page's headers, improving navigation within the documentation.
+
+3. **Powerful Search:** Retype integrates advanced content search functionality, enabling developers to quickly locate the information they need.
+
+4. **Broken Link Detection:** Retype's compilers swiftly identify any broken links (including anchors), ensuring that your documentation remains error-free.
+
+5. **Advanced Code Block Features:** Retype's code blocks support features like [line highlighting](https://retype.com/components/code-block/#line-highlighting) and optional [titles](https://retype.com/components/code-block/#title), enhancing the presentation of code samples.
+
+6. **Outbound Links:** Retype automatically identifies and manages external [(outbound) links](https://retype.com/configuration/project/#outbound) within the project, opening them in new tabs when clicked for a smoother user experience.
+
+7. **Multiple Layouts:** Retype offers three distinct [layouts](https://retype.com/configuration/page/#layout) out of the box: `page`, `central`, and `blog`, allowing flexibility in presentation.
+
+8. **Pages Visibility Control:** Retype supports both [Private](https://retype.com/configuration/page/#private) & [Protected](https://retype.com/configuration/page/#protected) pages, enabling controlled access to content.
+
+9. **Custom CSS:** Retype allows to add [custom global CSS](https://retype.com/components/container/#custom-global-css) and [CSS classes to containers](https://retype.com/components/container/#custom--class).
+
+10. **The Hub functionality:** Retype's [hub functionality](https://retype.com/configuration/project/#hub) enables the interlinking of multiple websites, facilitating seamless navigation between related resources.
+
+By choosing Retype, we can take advantage of these features to enhance our documentation's organization, accessibility, and overall developers experience.
+
+