Feat/inbuilt docs: added new flag to show comprehensive docs in local browser

.github/workflows/github-pages.yml

@@ -0,0 +1,89 @@
+name: Deploy Documentation to GitHub Pages
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: 🦀 Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y pkg-config libssl-dev
+
+      - name: Cache Cargo
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ${{ runner.os }}-cargo-pages-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: 📦 Build project
+        run: cargo build --release
+
+      - name: 📚 Generate documentation
+        run: |
+          # Set environment variables to prevent browser opening
+          export GIT_EDITOR_NO_BROWSER=1
+          export NO_BROWSER=1
+
+          # Create docs directory
+          mkdir -p docs-site
+
+          # Generate the documentation HTML
+          cargo run --release -- --docs
+
+          # Copy the generated HTML to docs-site directory
+          cp /tmp/git-editor-docs.html docs-site/index.html
+
+          # Create a simple robots.txt for better SEO
+          echo -e "User-agent: *\nAllow: /" > docs-site/robots.txt
+
+          # Create a .nojekyll file to bypass Jekyll processing
+          touch docs-site/.nojekyll
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs-site'
+
+  deploy:
+    name: Deploy to GitHub Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    # Only deploy on pushes to main/master, not on PRs
+    if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Cargo.toml

@@ -19,6 +19,7 @@ url = "2.5.4"
 uuid = { version = "1.17.0", features = ["v4"] }
 crossterm = "0.27"
 tempfile = "3.0"
+open = "5.0"
 
 [dev-dependencies]
 serial_test = "3.0"

README.md

@@ -38,6 +38,28 @@ cargo build --release
 # The binary will be available at target/release/git-editor
 ```
 
+## Documentation
+
+📚 **Comprehensive documentation is available online:** [rohansen856.github.io/git-editor](https://rohansen856.github.io/git-editor)
+
+The online documentation includes:
+- Complete command reference with examples
+- Technical implementation details
+- Architecture overview and development guidelines
+- Interactive copy-to-clipboard code examples
+- Troubleshooting guide and FAQ
+- Advanced usage patterns and best practices
+
+### Quick Access to Documentation
+
+You can also access the documentation directly from the command line:
+
+```bash
+git-editor --docs
+```
+
+This command will generate and open the comprehensive documentation in your default browser.
+
 ## Usage
 
 Git Editor supports five main modes of operation: