Rewrite doc and steal astral style

Author: jpvelez

docs/index.md

@@ -1,15 +1,56 @@
 # Switchbox Copier Template
 
-A standalone Copier template with native conditional files/dirs. Supports Python with optional data science tools, package publishing, GitHub Actions, devcontainers, and AWS CLI.
+This is a modern [copier](https://copier.readthedocs.io/en/stable/) template you can use to create python and R data science projects, using modern tools, including [devcontainers](https://containers.dev/).
+
+It supports the following features:
+
+### Python data science
+- PyData packages: [polars](https://pola.rs/), [seaborn](https://seaborn.pydata.org/)
+- [Quarto](https://quarto.org/) notebooks
+- [uv](https://docs.astral.sh/uv/) for dependency management
+- [ruff](https://docs.astral.sh/ruff/) for code linting and formatting
+- [ty](https://docs.astral.sh/ty/) for type checking
+
+### R data science
+- Tidyverse packages: [dplyr](https://dplyr.tidyverse.org/), [ggplot2](https://ggplot2.tidyverse.org/), etc.
+- [Quarto](https://quarto.org/) notebooks
+- [pak](TK) for dependency management
+- [air](https://posit-dev.github.io/air/) for code formatting
+- [radian](https://github.com/randy3k/radian) for R console
+- Fast install of binary packages via [P3M](https://packagemanager.posit.co/__docs__/admin/serving-binaries.html)
+
+### Python packages
+- Modern python tooling: uv, ruff, ty, pytest, tox
+- [hatchling](https://pypi.org/project/hatchling/) for package building
+- [twine][https://twine.readthedocs.io/en/stable/] for package publishing
+- MkDocs documentation with Material theme
+
+All project types include:
+- [just](https://just.systems/man/en/) for task automation and project management
+- [devcontainers](https://containers.dev/) for consistent development environments in VSCode, Cursor, Positron, and other IDEs
+- [prek](https://prek.j178.dev/) for fast pre-commit hooks that automate code quality checks
+- AWS integration (Optional): ([aws cli](https://aws.amazon.com/cli/), [boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) for Python)
+- GitHub Actions Workflows (Optional): to run code quality checks and tests via CI/CD
+
 
 ## Quickstart
 
+First, make sure you have copier installed. We recommend doing this with uv or pipx:
+
 ```bash
-pipx install copier
-copier copy https://github.com/switchbox-data/switchbox-copier-template my-project
+uv tool install copier # or: pipx install copier
 ```
 
-## Why Copier
+On your local machine, navigate to the directory in which you want to create your project, and run the following command:
+
+```bash
+copier copy https://github.com/switchbox-data/switchbox-copier-template <my-project>
+```
+
+Where `<my-project>` is the name you want to give your project. This will be used as the directory name, and as the name of your repo if you use GitHub. 
+
+Follow the prompts to configure your project. Once completed, a new directory containing your project will be created. Then navigate into your newly created project directory and follow the instructions in the `README.md` to complete the setup of your project.
+
+## Acknowledgements
 
-- Native conditional paths; no post-gen cleanup hooks
-- Simple upgrades via `copier update`
+This project is inspired by the [cookiecutter-uv](https://fpgmaas.github.io/cookiecutter-uv/) package.

docs/options.md

@@ -0,0 +1,110 @@
+# Prompt Arguments
+
+When running the `copier copy` command, you'll be prompted with several questions to configure your project. Here's what each option does:
+
+---
+
+**author**
+
+Your full name. This will be used in documentation, license files, and package metadata.
+
+**email**
+
+Your email address. Used for package metadata and contact information.
+
+**author_github_handle**
+
+Your GitHub username or organization. This is used to set up repository URLs and documentation links.
+
+**project_description**
+
+A short description of your project. This appears in README files, package metadata, and documentation.
+
+**project_features**
+
+This is a **multiselect** option where you can choose one or more project types:
+
+- `python_data_science`: Sets up a Python data science environment with:
+  - Polars, PyArrow, Seaborn, NumPy for data analysis
+  - Quarto notebooks for reproducible research
+  - Modern Python tooling (uv, ruff, ty)
+  
+  
+- `r_data_science`: Sets up an R data science environment with:
+  - Tidyverse libraries (ggplot2, dplyr, etc.)
+  - Quarto notebooks
+  - Modern R tooling (pak, air, radian)
+  - Fast package installation via P3M
+
+- `python_package`: Creates a Python package with:
+  - Build tools (hatchling)
+  - Testing framework (pytest, tox)
+  - Documentation (MkDocs with Material theme)
+  - Publishing workflow (PyPI)
+  
+You can select multiple features! Here are some common combinations:
+
+*Python data science project*:
+```yaml
+project_features: ["python_data_science"]
+```
+
+*R data science project*:
+```yaml
+project_features: ["r_data_science"]
+```
+
+*Polyglot data science project*:
+```yaml
+project_features: ["python_data_science", "r_data_science"]
+```
+
+*Python package for distribution*:
+```yaml
+project_features: ["python_package"]
+```
+
+*Hybrid python project (data science + package)*:
+```yaml
+project_features: ["python_data_science", "python_package"]
+```
+
+
+**use_github**
+
+`true` or `false`. When enabled, this adds:
+- GitHub Actions workflows for CI/CD
+- Issue and pull request templates
+- Automated testing and deployment
+- Documentation publishing to GitHub Pages
+
+**open_source_license**
+
+Choose a license for your project. Options:
+- `MIT license` - Permissive, widely used
+- `BSD license` - Similar to MIT, with additional attribution requirements
+- `ISC license` - Very permissive, minimal text
+- `Apache Software License 2.0` - Includes patent protection
+- `GNU General Public License v3` - Copyleft, requires derivative works to be open source
+- `Not open source` - No license file generated
+
+**aws**
+
+`true` or `false`. When enabled, includes:
+- AWS CLI configuration
+- Boto3 for Python projects
+- AWS-related development tools and examples
+
+---
+
+## Computed Variables
+
+The template automatically computes several values based on your choices:
+
+**project_name**: Automatically set to the directory name you specify when running copier
+
+**project_slug**: Automatically generated from project_name by converting to lowercase and replacing hyphens with underscores. This is used for:
+- Python package names
+- Import statements: `from project_slug import module`
+- Directory structures
+

docs/promp_arguments.md

@@ -0,0 +1,67 @@
+:root {
+  --black: #222022;
+  --grey: #353038;
+  --white: #ffffff;
+  --nebula: #d7ff64;
+  --flare: #6340ac;
+  --rock: #78876e;
+  --galaxy: #261230;
+  --space: #30173d;
+  --comet: #6f5d6f;
+  --cosmic: #de5fe9;
+  --sun: #ffac2f;
+  --electron: #46ebe1;
+  --aurora: #46eb74;
+  --constellation: #5f6de9;
+  --neutron: #cff3cf;
+  --proton: #f6afbc;
+  --nebula: #cdcbfb;
+  --supernova: #f1aff6;
+  --starlight: #f4f4f1;
+  --lunar: #fbf2fc;
+  --asteroid: #e3cee3;
+  --crater: #f0dfdf;
+}
+
+[data-md-color-scheme="astral-light"] {
+  --md-default-bg-color--dark: var(--black);
+  --md-primary-fg-color: var(--galaxy);
+  --md-typeset-a-color: var(--flare);
+  --md-accent-fg-color: var(--cosmic);
+}
+
+[data-md-color-scheme="astral-dark"] {
+  --md-default-bg-color: var(--black);
+  --md-default-fg-color: var(--white);
+  --md-default-fg-color--light: var(--white);
+  --md-default-fg-color--lighter: var(--white);
+  --md-primary-fg-color: var(--space);
+  --md-primary-bg-color: var(--white);
+  --md-accent-fg-color: var(--cosmic);
+
+  --md-typeset-color: var(--white);
+  --md-typeset-a-color: var(--nebula);
+  --md-typeset-mark-color: var(--sun);
+
+  --md-code-fg-color: var(--white);
+  --md-code-bg-color: var(--grey);
+
+  --md-code-hl-comment-color: var(--asteroid);
+  --md-code-hl-punctuation-color: var(--asteroid);
+  --md-code-hl-generic-color: var(--supernova);
+  --md-code-hl-variable-color: var(--starlight);
+  --md-code-hl-string-color: var(--nebula);
+  --md-code-hl-keyword-color: var(--supernova);
+  --md-code-hl-operator-color: var(--supernova);
+  --md-code-hl-number-color: var(--electron);
+  --md-code-hl-special-color: var(--electron);
+  --md-code-hl-function-color: var(--neutron);
+  --md-code-hl-constant-color: var(--nebula);
+  --md-code-hl-name-color: var(--md-code-fg-color);
+
+  --md-typeset-del-color: hsla(6, 90%, 60%, 0.15);
+  --md-typeset-ins-color: hsla(150, 90%, 44%, 0.15);
+
+  --md-typeset-table-color: hsla(0, 0%, 100%, 0.12);
+  --md-typeset-table-color--light: hsla(0, 0%, 100%, 0.035);
+}

docs/stylesheets/extra.css

@@ -0,0 +1,90 @@
+# Tutorial
+
+This page contains a complete tutorial on how to create your project.
+
+## Step 1: Install copier
+To start, we will need to install `copier`. 
+
+We recommend doing so with `uv`. If you don't have `uv`, installation instructions can be found
+[here](https://docs.astral.sh/uv/#getting-started). For MacOS or Linux;
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Then you can use `uv` to install `copier`:
+
+```bash
+uv tool install copier
+```
+
+Alternatively, once you have `uv` installed, you can use `uvx` to use `copier` without actually installing it:
+
+```bash
+uvx copier copy ...
+```
+## Step 2: Generate your project
+
+On your local machine, navigate to the directory in which you want to
+create your project, and run the following command:
+
+```bash
+copier copy --trust https://github.com/switchbox-data/data-science-project.git <project-name>
+```
+
+For an explanation of the prompt arguments, see
+[Prompt Arguments](../prompt_arguments).
+
+Follow the prompts to configure your project. Once completed, a new directory containing your project will be created. A git repo will automatically be created, and the generated files will be committed.
+
+## Step 3: Set up your Github repository
+
+Create an empty [new repository](https://github.com/new) on Github. Give
+it a name that matches `<project-name>` above. The name should contain alphanumeric characters and optionally `-`.
+
+DO NOT check any boxes under the option `Initialize this repository
+with`.
+
+## Step 4: Upload your project to Github
+
+Run the following commands, replacing `<project-name>` with the name
+that you also gave the Github repository and `<github_author_handle>` with the Github username or organization where you made your repo.
+
+```bash
+cd <project_name>
+git remote add origin [email protected]:<github_author_handle>/<project_name>.git
+git push -u origin main
+```
+
+### Step 5: Set Up Your Development Environment
+
+Initially, the CI/CD pipeline will fail for two reasons:
+
+- The project does not yet contain a `uv.lock` file
+- There are a few formatting issues in the project
+
+To fix that, we first install the environment and the pre-commit hooks with:
+
+```bash
+just install
+```
+
+This will generate the `uv.lock` file
+
+### Step 6: Run the pre-commit hooks
+
+Now, to resolve the formatting issues, let's run the pre-commit hooks:
+
+```bash
+uv run pre-commit run -a
+```
+
+### 7. Commit the changes
+
+Now we commit the changes made by the two steps above to the repository:
+
+```bash
+git add .
+git commit -m 'Fix formatting issues'
+git push origin main
+```