diff --git a/CLAUDE.md b/CLAUDE.md index 7f3bd32..3b4c135 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co Airdrop is a Laravel package that speeds up deployments by skipping asset compilation when possible. It calculates a hash of build inputs (packages, JS/CSS files, ENV vars, etc.) and reuses previously built assets if the configuration hasn't changed. -Full docs: https://hammerstone.dev/airdrop/docs +Full docs: https://wilbergroup.github.io/airdrop/ (built with Docsify from the `docs/` folder, served via GitHub Pages) ## Commands diff --git a/README.md b/README.md index 4e4335a..9dc5491 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Total Downloads](https://img.shields.io/packagist/dt/aaronfrancis/airdrop)](https://packagist.org/packages/aaronfrancis/airdrop) [![License](https://img.shields.io/packagist/l/aaronfrancis/airdrop)](https://packagist.org/packages/aaronfrancis/airdrop) -> Read the full docs at [hammerstone.dev/airdrop/docs](https://hammerstone.dev/airdrop/docs/main/overview). +> Read the full docs at [wilbergroup.github.io/airdrop](https://wilbergroup.github.io/airdrop/). Airdrop for Laravel is a package that speeds up your deploys by skipping your asset build step whenever possible. @@ -27,7 +27,7 @@ php artisan airdrop:install You'll likely want to publish the config file so that you can set up your triggers and outputs. -Read the full docs at [hammerstone.dev/airdrop/docs](https://hammerstone.dev/airdrop/docs/main/overview). +Read the full docs at [wilbergroup.github.io/airdrop](https://wilbergroup.github.io/airdrop/). ## License diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..47503e1 --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,13 @@ +- [Overview](overview.md) +- [Installation](installation.md) +- [Configuration](configuration.md) +- [Deploying](deploying.md) +- Triggers + - [Config Trigger](triggers/config.md) + - [File Trigger](triggers/file.md) + - [Custom](triggers/custom.md) +- Drivers + - [Filesystem](drivers/filesystem.md) + - [GitHub Actions](drivers/github.md) + - [Custom](drivers/custom.md) +- [Debugging](debugging.md) diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..89f1a0f --- /dev/null +++ b/docs/index.html @@ -0,0 +1,35 @@ + + + + + Airdrop for Laravel + + + + + + +
Loading the docs…
+ + + + + + + + diff --git a/docs/overview.md b/docs/overview.md index 31d902d..b63d2a9 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -9,7 +9,7 @@ When you're deploying your code, Airdrop will calculate a hash of everything nee After Airdrop has calculated a hash for these inputs, it will check to see if it has ever built this exact configuration before. If it has, it will pull down the built assets and put them in place, letting you skip the expensive build step. -![Flowchart](/flowchart.png){style="width: 698px"} +Flowchart This can reduce the time your deploys and CI runs take from minutes down to just a few seconds: diff --git a/docs/triggers/custom.md b/docs/triggers/custom.md index 976d9bc..e637be5 100644 --- a/docs/triggers/custom.md +++ b/docs/triggers/custom.md @@ -1,6 +1,6 @@ # Building a Custom Trigger -If the [File](/triggers/file) and [Config](triggers/config) triggers don't meet your needs, you are free to make your own. +If the [File](/triggers/file) and [Config](/triggers/config) triggers don't meet your needs, you are free to make your own. Let's imagine we want to trigger an asset rebuild any time the week of the year changes. This will force assets to be built at least once a week, provided we deploy at least once a week.