Re-add MkDocs documentation (#31)

* docs: re-add MkDocs documentation

Author: allisonwang-db

contributing/DEVELOPMENT.md

@@ -111,10 +111,27 @@ uv run pre-commit run --all-files
 
 ### Building Documentation
 
-The project previously used MkDocs for documentation. Documentation now lives primarily in:
-- README.md - Main documentation
-- Docstrings in source code
-- Contributing guides in /contributing
+MkDocs (Material theme) powers the public documentation site hosted at `https://allisonwang-db.github.io/pyspark-data-sources/`.
+
+#### Preview Locally
+
+Run the live preview server (restarts on save):
+
+```bash
+poetry run mkdocs serve
+```
+
+The site is served at `http://127.0.0.1:8000/` by default.
+
+#### Build for Verification
+
+Before sending a PR, ensure the static build succeeds and address any warnings:
+
+```bash
+poetry run mkdocs build
+```
+
+Common warnings include missing navigation entries or broken links—update `mkdocs.yml` or the relevant Markdown files to resolve them.
 
 ### Writing Docstrings
 

contributing/RELEASE.md

@@ -180,6 +180,21 @@ gh workflow run docs.yml
 # Go to Actions tab → Deploy MkDocs to GitHub Pages → Run workflow
 ```
 
+### Releasing the Documentation Site
+
+Follow these steps when you want to publish documentation updates:
+
+1. Verify the docs build locally:
+   ```bash
+   poetry run mkdocs build
+   ```
+2. Commit any updated Markdown or configuration files and push to the default branch. This triggers the `docs.yml` workflow, which rebuilds and publishes the site to GitHub Pages.
+3. (Optional) If you need to deploy immediately without waiting for CI, run:
+   ```bash
+   poetry run mkdocs gh-deploy
+   ```
+   This command builds the site and pushes it to the `gh-pages` branch directly.
+
 ### Documentation URLs
 
 - **Live Docs**: https://allisonwang-db.github.io/pyspark-data-sources

docs/datasources/arrow.md

@@ -0,0 +1,6 @@
+# ArrowDataSource
+
+> Requires the [`PyArrow`](https://arrow.apache.org/docs/python/) library. You can install it manually: `pip install pyarrow`
+> or use `pip install pyspark-data-sources[arrow]`.
+
+::: pyspark_datasources.arrow.ArrowDataSource

docs/datasources/fake.md

@@ -0,0 +1,6 @@
+# FakeDataSource
+
+> Requires the [`Faker`](https://github.com/joke2k/faker) library. You can install it manually: `pip install faker`
+> or use `pip install pyspark-data-sources[faker]`.
+
+::: pyspark_datasources.fake.FakeDataSource

docs/datasources/github.md

@@ -0,0 +1,3 @@
+# GithubDataSource
+
+::: pyspark_datasources.github.GithubDataSource

docs/datasources/googlesheets.md

@@ -0,0 +1,3 @@
+# GoogleSheetsDataSource
+
+::: pyspark_datasources.googlesheets.GoogleSheetsDataSource

docs/datasources/huggingface.md

@@ -0,0 +1,5 @@
+# HuggingFaceDatasets
+
+> Requires the [`datasets`](https://huggingface.co/docs/datasets/en/index) library.
+
+::: pyspark_datasources.huggingface.HuggingFaceDatasets

docs/datasources/jsonplaceholder.md

@@ -0,0 +1,3 @@
+# JSONPlaceholderDataSource
+
+::: pyspark_datasources.jsonplaceholder.JSONPlaceholderDataSource

docs/datasources/kaggle.md

@@ -0,0 +1,5 @@
+# KaggleDataSource
+
+> Requires the [`kagglehub`](https://github.com/Kaggle/kagglehub) library.
+
+::: pyspark_datasources.kaggle.KaggleDataSource

docs/datasources/lance.md

@@ -0,0 +1,6 @@
+# LanceSink
+
+> Requires the [`Lance`](https://lancedb.github.io/lance/) library. You can install it manually: `pip install lance`
+> or use `pip install pyspark-data-sources[lance]`.
+
+::: pyspark_datasources.lance.LanceSink