refactor: refactor doc site (#37)

bakayu · web-flow · commit 0ba3ad0f1ed6 · 2026-03-02T15:56:23.000+05:30
Signed-off-by: Ayush &lt;mail@ayuch.dev&gt;
diff --git a/content/en/_index.md b/content/en/_index.md
@@ -1,9 +1,9 @@
 ---
-title: GITx
+title: gitx
 linkTitle: gitx
 ---
 
-{{< blocks/cover title="Welcome to GITx" image_anchor="top" height="full" >}}
+{{< blocks/cover title="Welcome to gitx" image_anchor="top" height="full" >}}
 <a class="btn btn-lg btn-primary me-3 mb-4" href="./learn/">
   Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
 </a>
@@ -16,14 +16,14 @@ linkTitle: gitx
 
 
 {{% blocks/lead color="primary" %}}
-GITx provides a single terminal UI providing visibility into your git workflow,
+gitx provides a single terminal UI providing visibility into your git workflow,
 and providing a guided experience to learning and using Git.
 {{% /blocks/lead %}}
 
 
 {{% blocks/section color="dark" type="row" %}}
 {{% blocks/feature icon="fa-lightbulb" title="Interactive Learning" %}}
-The GITx UI helps you visualize your git history and workflow.
+The gitx UI helps you visualize your git history and workflow.
 
 Please follow this space for updates!
 {{% /blocks/feature %}}
@@ -39,4 +39,4 @@ For announcements, support, and to join the community.
 {{% /blocks/feature %}}
 
 
-{{% /blocks/section %}}
+{{% /blocks/section %}}
diff --git a/content/en/about/featured-background.png b/content/en/about/featured-background.png
diff --git a/content/en/about/index.md b/content/en/about/index.md
diff --git a/content/en/blog/how-to-contribute.md b/content/en/blog/how-to-contribute.md
@@ -1,12 +1,12 @@
 ---
-title: "How to Contribute a Blog Post to GITx Documentation"
+title: "How to Contribute a Blog Post to gitx Documentation"
 linkTitle: "Contributing Blog Posts"
 date: 2025-10-02
-description: "A step-by-step guide on how to write and submit your first blog post to the GITx documentation site."
+description: "A step-by-step guide on how to write and submit your first blog post to the gitx documentation site."
 author: "bakayu"
 ---
 
-Welcome to the GITx blog! We're excited to have you here and even more excited if you're thinking about contributing your own post. This guide will walk you through the entire process of creating and submitting a blog post to our documentation site.
+Welcome to the gitx blog! We're excited to have you here and even more excited if you're thinking about contributing your own post. This guide will walk you through the entire process of creating and submitting a blog post to our documentation site.
 
 ## What Should You Write About?
 
@@ -137,7 +137,7 @@ After you submit your PR:
 - Our team will review your submission
 - We may provide feedback or suggestions for improvement
 - Once everything looks good, we'll merge your post
-- Your contribution will be live on the GITx documentation site! 🎉
+- Your contribution will be live on the gitx documentation site! 🎉
 
 Tips for Great Blog Posts:
 
diff --git a/content/en/contribute/_index.md b/content/en/contribute/_index.md
@@ -1,5 +1,5 @@
 ---
-title: "Contributing to GITx"
+title: "Contributing to gitx"
 linkTitle: "Contribute"
 
 menu: {main: {weight: 30}}
diff --git a/content/en/contribute/roadmap.md b/content/en/contribute/roadmap.md
@@ -154,6 +154,9 @@ type: "docs"
     <li><strong>Expanded Git Command Support:</strong> Integrate a wider range of Git commands to provide more comprehensive repository management capabilities.</li>
     <li><strong>Bug Fixes:</strong> Address any outstanding bugs to improve stability and reliability.</li>
     <li><strong>Command History and Logging:</strong> Allow the secondary panel to store all the git commands history and gitx logs.</li>
+    <li><strong>Repository Initialization:</strong> Add a feature that allows users to initialize a new Git repository in the current directory if one doesn't already exist.</li>
+    <li><strong>Safety Warnings:</strong> Implement a warning system to alert users when they are about to initialize a repository in a potentially problematic location.</li>
+    <li><strong>Custom Keybindings:</strong> Update config.toml logic to allow users to remap keys (currently hardcoded in keys.go).</li>
   </ul>
 </div>
 
@@ -167,12 +170,9 @@ type: "docs"
 <div class="roadmap-section planned">
   <h3>📋 Planned <span class="status-badge planned">Upcoming</span></h3>
   <ul>
-    <li><strong>Repository Initialization:</strong> Add a feature that allows users to initialize a new Git repository in the current directory if one doesn't already exist.</li>
-    <li><strong>Safety Warnings:</strong> Implement a warning system to alert users when they are about to initialize a repository in a potentially problematic location.</li>
     <li><strong>Improved Visual Diff Viewer:</strong> Enhance the diff viewer to provide a more intuitive and detailed representation of changes.</li>
     <li><strong>Interactive Staging:</strong> Allow users to stage and unstage individual lines or hunks of code directly from the visual diff viewer.</li>
     <li><strong>Merge Conflict Resolver:</strong> Build a tool to help users resolve merge conflicts from within the TUI.</li>
-    <li><strong>Custom Keybindings:</strong> Update config.toml logic to allow users to remap keys (currently hardcoded in keys.go).</li>
   </ul>
 </div>
 
diff --git a/content/en/learn/_index.md b/content/en/learn/_index.md
@@ -8,10 +8,10 @@ type: "docs"
 ---
 
 {{% pageinfo %}}
-This is the documentation for GITx, a TUI helper for learning and using Git.
+This is the documentation for gitx, a TUI helper for learning and using Git.
 {{% /pageinfo %}}
 
-GitX is a Terminal User Interface (TUI) helper designed to simplify the process of learning and using Git, the most widely used version control system (VCS). Instead of typing long and often confusing commands, GitX presents a more guided and interactive interface that helps beginners understand Git concepts while still working inside the terminal. It is especially useful for students, new developers, or anyone who wants to strengthen their Git fundamentals by not only providing an easy access to all the git functions but also educating about doing all the said exercises manually.
+gitx is a Terminal User Interface (TUI) helper designed to simplify the process of learning and using Git, the most widely used version control system (VCS). Instead of typing long and often confusing commands, gitx presents a more guided and interactive interface that helps beginners understand Git concepts while still working inside the terminal. It is especially useful for students, new developers, or anyone who wants to strengthen their Git fundamentals by not only providing an easy access to all the git functions but also educating about doing all the said exercises manually.
 
 ## Why do I want it?
 
@@ -23,6 +23,6 @@ Although `gitx` provides an easier and more efficient way to access all the func
 
 ## Where should I go next?
 
-- [Getting Started](./overview): Get started with GITx
-- [Installation](./docs/getting-started/installation): Install GITx
-- [Tutorials](./docs/tutorials/): Check out some tutorials for git!
+- [Overview](./overview): Overview
+- [Getting Started](./getting-started/): Install and learn how to use gitx.
+- [Tutorials](./tutorials/): Check out some tutorials for git!
diff --git a/content/en/learn/getting-started/01_installing_gitx.md b/content/en/learn/getting-started/01_installing_gitx.md
@@ -1,6 +1,6 @@
 ---
-title: Getting Started
-weight: 2
+title: Installing gitx
+weight: 1
 type: "docs"
 ---
 
@@ -12,7 +12,17 @@ The easiest way to install `gitx` is by using the installation script. Open your
 curl -sSL https://raw.githubusercontent.com/gitxtui/gitx/master/install.sh | bash
 ```
 
-This script will automatically detect your operating system and architecture, download the latest release of gitx, and install it to /usr/local/bin.
+This script will automatically detect your operating system and architecture, download the latest release of gitx, and install it to `/usr/local/bin`.
+
+## Using go install
+
+Requires `go` to be installed on your system:
+
+```bash
+go install github.com/gitxtui/gitx/cmd/gitx@latest
+```
+
+This will download the correct binary according to your operating system and place it at `~/go/bin/gitx`.
 
 ## Manual Installation
 
@@ -34,11 +44,10 @@ sudo mv gitx /usr/local/bin/
 To verify that gitx is installed correctly, change to a directory containing a git repo and run:
 
 ```Bash
-gitx
+gitx --version
 ```
 
+## Next steps:
 
-
-## Where should I go next?
-
-- [Tutorials](/docs/learn/tutorials/): Check out some tutorials for git!
+- [Learn gitx](/docs/learn/getting-started/02_using_gitx): Learn how to use gitx!
+- [Tutorials](/docs/learn/tutorials/): Check out some tutorials for git!
diff --git a/content/en/learn/getting-started/02_using_gitx/01_basics.md b/content/en/learn/getting-started/02_using_gitx/01_basics.md
@@ -0,0 +1,7 @@
+---
+title: Basics
+linkTitle: basics
+description: Learn the basics of gitx
+weight: 1
+type: "docs"
+---
diff --git a/content/en/learn/getting-started/02_using_gitx/02_key_binds.md b/content/en/learn/getting-started/02_using_gitx/02_key_binds.md
@@ -0,0 +1,7 @@
+---
+title: Keybinds
+linkTitle: keybinds
+description: Setting custom keybinds in gitx
+weight: 2
+type: "docs"
+---
diff --git a/content/en/learn/getting-started/02_using_gitx/03_theme.md b/content/en/learn/getting-started/02_using_gitx/03_theme.md
@@ -0,0 +1,7 @@
+---
+title: Custom Themes
+linkTitle: custom themes
+description: Setting custom themes in gitx
+weight: 3
+type: "docs"
+---
diff --git a/content/en/learn/getting-started/02_using_gitx/_index.md b/content/en/learn/getting-started/02_using_gitx/_index.md
@@ -0,0 +1,7 @@
+---
+title: Using gitx
+linkTitle: Using gitx
+description: Learn how to use gitx
+weight: 2
+type: "docs"
+---
diff --git a/content/en/learn/getting-started/_index.md b/content/en/learn/getting-started/_index.md
@@ -0,0 +1,14 @@
+---
+title: Getting Started
+linkTitle: Getting Started
+description: Get started with gitx
+weight: 2
+type: "docs"
+---
+
+Welcome to gitx! This guide will help you get up and running with gitx quickly. Follow the tutorials below to install gitx and learn how to use it effectively.
+
+## Tutorials
+
+- [Installing gitx](01_installing_gitx): Install gitx on your PC.
+- [Using gitx](02_using_gitx): Learn how to use gitx!
diff --git a/content/en/learn/overview.md b/content/en/learn/overview.md
@@ -1,6 +1,6 @@
 ---
 title: Overview
-description: Here's where your user finds out if your project is for them.
+description: The terminal friendly git helper - gitx.
 weight: 1
 type: "docs"
 ---
@@ -9,16 +9,9 @@ type: "docs"
 This is a placeholder page that shows you how to use this template site.
 {{% /pageinfo %}} -->
 
-The Overview is where your users find out about your project. Depending on the
-size of your docset, you can have a separate overview page (like this one) or
-put your overview contents in the Documentation landing page (like in the Docsy
-User Guide).
-
-Try answering these questions for your user in this page:
-
 ## What is it?
 
-GitX is a Terminal User Interface (TUI) helper designed to simplify the process of learning and using Git, the most widely used version control system (VCS). Instead of typing long and often confusing commands, GitX presents a more guided and interactive interface that helps beginners understand Git concepts while still working inside the terminal. It is especially useful for students, new developers, or anyone who wants to strengthen their Git fundamentals by not only providing an easy access to all the git functions but also educating about doing all the said exercises manually. 
+gitx is a Terminal User Interface (TUI) helper designed to simplify the process of learning and using Git, the most widely used version control system (VCS). Instead of typing long and often confusing commands, gitx presents a more guided and interactive interface that helps beginners understand Git concepts while still working inside the terminal. It is especially useful for students, new developers, or anyone who wants to strengthen their Git fundamentals by not only providing an easy access to all the git functions but also educating about doing all the said exercises manually. 
 
 ## Why do I want it?
 
@@ -30,7 +23,5 @@ Although `gitx` provides an easier and more efficient way to access all the func
 
 ## Where should I go next?
 
-Give your users next steps from the Overview. For example:
-
-- [Installation](/docs/learn/getting-started/installation): Install GITx
-- [Tutorials](/docs/learn/tutorials/): Check out some tutorials for git!
+- [Installation](./getting-started/01_installing_gitx): Install gitx
+- [Tutorials](/docs/learn/tutorials/): Check out some tutorials for git!
diff --git a/content/en/learn/tutorials/_index.md b/content/en/learn/tutorials/_index.md
@@ -1,14 +1,14 @@
 ---
 title: Tutorials
-description: Show your user how to work through some end to end examples.
+description: Follow along with these tutorials to learn git
 date: 2017-01-04
-weight: 8
+weight: 20
 type: "docs"
 ---
 
-{{% pageinfo %}}
+<!-- {{% pageinfo %}}
 This is a placeholder page that shows you how to use this template site.
-{{% /pageinfo %}}
+{{% /pageinfo %}} -->
 
-Tutorials are **complete worked examples** made up of **multiple tasks** that guide the user through a relatively simple but realistic scenario: building an application that uses some of your project’s features, for example. If you have already created some Examples for your project you can base Tutorials on them. This section is **optional**. However, remember that although you may not need this section at first, having tutorials can be useful to help your users engage with your example code, especially if there are aspects that need more explanation than you can easily provide in code comments.
+<!-- Tutorials are **complete worked examples** made up of **multiple tasks** that guide the user through a relatively simple but realistic scenario: building an application that uses some of your project’s features, for example. If you have already created some Examples for your project you can base Tutorials on them. This section is **optional**. However, remember that although you may not need this section at first, having tutorials can be useful to help your users engage with your example code, especially if there are aspects that need more explanation than you can easily provide in code comments. -->
 
diff --git a/hugo.yaml b/hugo.yaml
@@ -1,5 +1,5 @@
 baseURL: https://gitxtui.github.io/docs
-title: GITx
+title: gitx
 
 # Language settings
 contentDir: content/en
@@ -64,7 +64,8 @@ params:
   github_branch: master
 
   copyright:
-    authors: gitxtui | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
+    authors:
+      gitxtui | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
     from_year: 2025
 
   ui:
@@ -77,9 +78,13 @@ params:
     feedback:
       enable: true
       'yes': >-
-        Glad to hear it! Please <a href="https://github.com/gitxtui/gitx/issues/new">tell us how we can improve</a>.
+        Glad to hear it! Please <a
+        href="https://github.com/gitxtui/gitx/issues/new">tell us how we can
+        improve</a>.
       'no': >-
-        Sorry to hear that. Please <a href="https://github.com/gitxtui/gitx/issues/new">tell us how we can improve</a>.
+        Sorry to hear that. Please <a
+        href="https://github.com/gitxtui/gitx/issues/new">tell us how we can
+        improve</a>.
 
   links:
     developer:
@@ -92,11 +97,10 @@ params:
         icon: fab fa-discord
         desc: Join the community on Discord!
 
-
 module:
   hugoVersion:
     extended: true
     min: 0.146.0
   imports:
     - path: github.com/google/docsy
-      disable: false
+      disable: false
