Update documentation

Author: yyexela

.github/workflows/doctest.yml

@@ -10,8 +10,7 @@ on:
       - "!main"
       - "!gh-pages"
     paths: # Only generate documentation for changes to the SHRED-X package or documentation itself
-      - 'shredx/**'
-      - 'docs/**'
+      - '**'
   workflow_dispatch:
 
 permissions:

.github/workflows/lint_format.yml

@@ -10,8 +10,7 @@ on:
       - "!main"
       - "!gh-pages"
     paths: # Only run linting and formatting for changes to the SHRED-X package
-      - 'shredx/**'
-      - 'test/**'
+      - '**'
   workflow_dispatch:
 
 permissions:

.github/workflows/pytest.yml

@@ -10,8 +10,7 @@ on:
       - "!main"
       - "!gh-pages"
     paths: # Only run tests for changes to the SHRED-X package
-      - 'shredx/**'
-      - 'test/**'
+      - '**'
   workflow_dispatch:
 
 permissions:

README.md

@@ -1,17 +1,42 @@
 # SHRED-X
 
-This package is in development. Eventually, it will be a comprehensive SHRED package, containing all published SHRED models for research and industrial purposes. We are starting out with a PyTorch implementation but have goals to make it Jax-compatible as well.
+**A modular PyTorch framework for Shallow Recurrent Decoders** -- reconstruct full spatiotemporal fields from sparse sensor measurements.
 
 Website: [https://yyexela.github.io/SHRED-X/](https://yyexela.github.io/SHRED-X/)
 
-## Environment
+## Documentation
 
-The environment can be created by running:
+Full documentation is hosted at **[yyexela.github.io/SHRED-X](https://yyexela.github.io/SHRED-X/)** and includes:
+
+- [Getting Started](https://yyexela.github.io/SHRED-X/getting_started.html) -- installation and quickstart
+- [Tutorials](https://yyexela.github.io/SHRED-X/tutorials.html) -- end-to-end notebooks
+- [API Reference](https://yyexela.github.io/SHRED-X/api.html) -- complete module/class/function docs
+- [Contributing](https://yyexela.github.io/SHRED-X/contributing.html) -- development setup and workflow
+
+
+## Installation
 
 ```bash
+git clone https://github.com/yyexela/SHRED-X.git
+cd SHRED-X
+
 pyenv install 3.13.7
 pyenv local 3.13.7
 python -m venv ~/.virtualenvs/shredx
 source ~/.virtualenvs/shredx/bin/activate
 pip install -e .
 ```
+
+For development (tests, linting, type checking, docs):
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Citations
+
+If you use SHRED in your research, please cite the relevant papers listed on the [Citations](https://yyexela.github.io/SHRED-X/citations.html) page.
+
+## Contributing
+
+See the [Contributing guide](https://yyexela.github.io/SHRED-X/contributing.html) for details.