Updated docs

Author: kcleal

.github/workflows/pages.yml

@@ -8,7 +8,7 @@ name: Deploy Jekyll site to Pages
 
 on:
   push:
-    branches: ["main", "gw_dev"]
+    branches: ["main", "gwplot_dev"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

README.md

@@ -2,40 +2,17 @@
 
 `gwplot` is a plotting library for genomics data and a Python interface to GW, a high-performance interactive genome browser.
 
-Visit the documentation for more details:  https://kcleal.github.io/gwplot/
+Visit the [documentation for more details](https://kcleal.github.io/gwplot/)
 
 [![Build Status](https://github.com/kcleal/gwplot/actions/workflows/build.yml/badge.svg)](https://github.com/kcleal/gwplot/actions)
 
-## Overview
-
-`gwplot` can be used for rapid visualization of:
-
-- Aligned sequencing reads (BAM files)
-- Genomic data tracks (VCF, BED, etc.)
-- Structural variants and complex rearrangements
-- Entire chromosomes with minimal memory usage
-
 
 ## Installation
 
-### From PyPI
-
 ```bash
 pip install gwplot
 ```
 
-### Building from Source (macOS)
-
-```bash
-# Install dependencies with Homebrew
-brew install fontconfig freetype glfw htslib jpeg-turbo libpng xz
-
-git clone --recursive https://github.com/kcleal/gwplot
-cd gwplot
-pip install -r requirements.txt
-pip install .
-```
-
 ## Quick Start
 
 ```python

docs/Gemfile

@@ -1,9 +1,5 @@
 source 'https://rubygems.org'
 
-gem "jekyll", "~> 4.3.2" # installed by `gem jekyll`
-# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
-
-gem "just-the-docs", "0.10.1" # pinned to the current release
-# gem "just-the-docs"        # always download the latest release
-
-# gem "github-pages", group: :jekyll_plugins
+gem 'jekyll', '~> 4.3.2'
+gem 'just-the-docs', '~> 0.8.2'
+gem 'webrick', '~> 1.8'  # Required for Ruby 3+ with Jekyll 4+

docs/Gemfile.lock

@@ -1,22 +1,21 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     colorator (1.1.0)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.3.5)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.15.5)
+    ffi (1.17.1-arm64-darwin)
     forwardable-extended (2.6.0)
-    google-protobuf (3.25.5-arm64-darwin)
-    google-protobuf (3.25.5-x86_64-linux)
+    google-protobuf (3.23.4-arm64-darwin)
     http_parser.rb (0.8.0)
-    i18n (1.14.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    jekyll (4.3.2)
+    jekyll (4.3.4)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -45,40 +44,39 @@ GEM
       jekyll-include-cache
       jekyll-seo-tag (>= 2.0)
       rake (>= 12.3.1)
-    kramdown (2.4.0)
-      rexml
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liquid (4.0.4)
-    listen (3.8.0)
+    listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (5.0.3)
-    rake (13.0.6)
+    public_suffix (5.1.1)
+    rake (13.2.1)
     rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rexml (3.3.9)
+    rexml (3.4.1)
     rouge (3.30.0)
     safe_yaml (1.0.5)
-    sass-embedded (1.58.3)
+    sass-embedded (1.58.3-arm64-darwin)
       google-protobuf (~> 3.21)
-      rake (>= 10.0.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    unicode-display_width (2.5.0)
-    webrick (1.8.2)
+    unicode-display_width (2.6.0)
+    webrick (1.9.1)
 
 PLATFORMS
-  arm64-darwin-22
-  x86_64-linux
+  arm64-darwin-24
 
 DEPENDENCIES
   jekyll (~> 4.3.2)
-  just-the-docs (= 0.10.1)
+  just-the-docs (~> 0.8.2)
+  webrick (~> 1.8)
 
 BUNDLED WITH
    2.3.26