Update GitHub Pages docs target URL
Summary
Updated the GitHub Pages workflow so the generated root landing page now redirects explicitly to https://dirtydishes.github.io/islandflow/docs/.
Changes Made
- Edited
.github/workflows/docs-pages.yml. - Changed the root
site/index.htmlmeta-refresh and fallback link from a relative./docs/target to an absolute Pages URL target.
Context
The existing docs Pages workflow already copied repository docs into site/docs/. The requested update was to ensure the published root route consistently forwards to the canonical project URL dirtydishes.github.io/islandflow/docs.
Important Implementation Details
- Deployment artifact structure remains unchanged: docs are still published under
site/docs/. - Only the redirect target changed, minimizing risk of deployment regressions.
- Fallback anchor text now points to the same absolute URL as the redirect destination.
Relevant Diff Snippets
Snippet style follows diffs.com formatting conventions.
--- .github/workflows/docs-pages.yml
+++ .github/workflows/docs-pages.yml
@@
-printf '%s\n' '<!doctype html>... url=./docs/...<a href="./docs/">Continue to docs</a>' > site/index.html
+printf '%s\n' '<!doctype html>... url=https://dirtydishes.github.io/islandflow/docs/...<a href="https://dirtydishes.github.io/islandflow/docs/">Continue to docs</a>' > site/index.html
Expected Impact for End-Users
- Visiting the Pages root now consistently routes users to
/islandflow/docs/on the canonical host. - Users get a stable docs destination regardless of relative path behavior.
Validation
- Reviewed workflow diff to confirm only redirect target changed.
- Attempted to run
bunx actionlint .github/workflows/docs-pages.yml, but the package executable could not be resolved in this environment.
Issues, Limitations, and Mitigations
- Absolute URL redirect is now tied to the current canonical host/path; if Pages host naming changes, this line must be updated.
- No runtime workflow execution was performed locally; final validation occurs on next GitHub Actions run.
Follow-up Work
- Add
actionlintas a repo-managed dev tool or CI check so workflow linting is repeatable in local and CI environments.