Fix ci.yml and added new documentation

Author: agilira

.github/workflows/ci.yml

@@ -1,45 +1,21 @@
-name: CI/CD Pipeline
+name: CI
 
 on:
   push:
     branches: [ main, develop ]
-    tags: [ 'v*' ]
   pull_request:
     branches: [ main, develop ]
 
 env:
   GO_VERSION: '1.24.5'
-  CGO_ENABLED: 0
 
 jobs:
-  validate:
-    name: Validate Workflow
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-
-    - name: Validate workflow syntax
-      run: |
-        # Check if workflow files are valid YAML
-        python3 -c "import yaml; yaml.safe_load(open('.github/workflows/ci.yml'))"
-        echo "✅ Workflow syntax is valid"
-        
-    - name: Check workflow context usage
-      run: |
-        # Check for potential context issues
-        if grep -q "steps\." .github/workflows/ci.yml; then
-          echo "⚠️  Found steps context usage - verifying validity"
-        fi
-        echo "✅ Workflow context usage appears valid"
-
   test:
-    name: Test & Coverage
+    name: Test
     runs-on: ubuntu-latest
     strategy:
       matrix:
         go-version: [1.24.4, 1.24.5]
-        platform: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:
     - name: Checkout code
@@ -54,9 +30,7 @@ jobs:
     - name: Install dependencies
       run: go mod download
 
-    - name: Run tests with coverage
-      env:
-        CGO_ENABLED: 1
+    - name: Run tests
       run: |
         go test -v -race -coverprofile=coverage.out -covermode=atomic ./...
         go tool cover -func=coverage.out
@@ -65,15 +39,12 @@ jobs:
       uses: codecov/codecov-action@v4
       with:
         file: ./coverage.out
-        flags: unittests
-        name: codecov-umbrella
         fail_ci_if_error: false
-        verbose: true
 
   quality:
     name: Code Quality
     runs-on: ubuntu-latest
-    needs: [validate, test]
+    needs: [test]
 
     steps:
     - name: Checkout code
@@ -111,17 +82,10 @@ jobs:
     - name: Run gosec
       run: gosec ./...
 
-    - name: Check for race conditions
-      env:
-        CGO_ENABLED: 1
-      run: go test -race ./...
-
-
-
   build:
     name: Build
     runs-on: ubuntu-latest
-    needs: [validate, test, quality]
+    needs: [test, quality]
     strategy:
       matrix:
         goos: [linux, windows, darwin]
@@ -145,106 +109,4 @@ jobs:
         GOOS: ${{ matrix.goos }}
         GOARCH: ${{ matrix.goarch }}
         CGO_ENABLED: 0
-      run: |
-        go build -v -ldflags="-s -w" ./...
-        go test -c ./...
-
-    - name: Upload build artifacts
-      uses: actions/upload-artifact@v4
-      with:
-        name: build-${{ matrix.goos }}-${{ matrix.goarch }}
-        path: |
-          *.exe
-          *.test
-        retention-days: 7
-
-  benchmark:
-    name: Benchmark
-    runs-on: ubuntu-latest
-    needs: [validate, test]
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-
-    - name: Set up Go
-      uses: actions/setup-go@v4
-      with:
-        go-version: ${{ env.GO_VERSION }}
-        cache: true
-
-    - name: Run benchmarks
-      run: |
-        go test -bench=. -benchmem ./...
-        go test -bench=. -benchmem -cpu=1,2,4 ./...
-
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    needs: [test, quality, build]
-    if: startsWith(github.ref, 'refs/tags/v')
-    permissions:
-      contents: write
-      packages: write
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-
-    - name: Set up Go
-      uses: actions/setup-go@v4
-      with:
-        go-version: ${{ env.GO_VERSION }}
-        cache: true
-
-    - name: Build for multiple platforms
-      env:
-        CGO_ENABLED: 0
-      run: |
-        # Build for current platform
-        go build -v -ldflags="-s -w" -o go-errors ./...
-        
-        # Build for other platforms
-        GOOS=linux GOARCH=amd64 go build -v -ldflags="-s -w" -o go-errors-linux-amd64 ./...
-        GOOS=linux GOARCH=arm64 go build -v -ldflags="-s -w" -o go-errors-linux-arm64 ./...
-        GOOS=windows GOARCH=amd64 go build -v -ldflags="-s -w" -o go-errors-windows-amd64.exe ./...
-        GOOS=darwin GOARCH=amd64 go build -v -ldflags="-s -w" -o go-errors-darwin-amd64 ./...
-        GOOS=darwin GOARCH=arm64 go build -v -ldflags="-s -w" -o go-errors-darwin-arm64 ./...
-
-    - name: Generate checksums
-      run: |
-        sha256sum go-errors* > checksums.txt
-
-    - name: Create Release
-      id: create_release
-      uses: softprops/action-gh-release@v2
-      with:
-        tag_name: ${{ github.ref_name }}
-        name: Release ${{ github.ref_name }}
-        draft: false
-        prerelease: false
-        files: |
-          go-errors
-          go-errors-linux-amd64
-          go-errors-linux-arm64
-          go-errors-windows-amd64.exe
-          go-errors-darwin-amd64
-          go-errors-darwin-arm64
-          checksums.txt
-        generate_release_notes: true
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  dependency-review:
-    name: Dependency Review
-    runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request'
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v4
-
-    - name: Dependency Review
-      uses: actions/dependency-review-action@v4
-      with:
-        fail-on-severity: moderate 
+      run: go build -v ./...