From a61dbc884d92181d3470485db337b9909890c60a Mon Sep 17 00:00:00 2001 From: David Benn Date: Thu, 7 May 2026 21:21:00 +0930 Subject: [PATCH 1/2] #592: extract docs landing page HTML from workflow into separate file Move docs/index.html template from an inline heredoc in docs.yml (which caused a YAML syntax error) to .github/pages/docs-index.html. The workflow now checks out master to obtain the template and copies it to gh-pages during staging. Co-authored-by: Cursor --- .github/pages/docs-index.html | 202 ++++++++++++++++++++++++++++++++ .github/workflows/docs.yml | 213 ++-------------------------------- 2 files changed, 210 insertions(+), 205 deletions(-) create mode 100644 .github/pages/docs-index.html diff --git a/.github/pages/docs-index.html b/.github/pages/docs-index.html new file mode 100644 index 00000000..ccef1baa --- /dev/null +++ b/.github/pages/docs-index.html @@ -0,0 +1,202 @@ + + + + + +VStar — Documentation + + + + +
+

VStar — Documentation

+

User manual, plugin development guide, and individual plugin docs

+ ← Back to VStar Project Hub +
+ +
+ +

Snapshot (development)

+ +
+

User Manual

+
Loading…
+
+ Open PDF +
+
+ +
+

Plugin Development Guide

+
+ Open PDF +
+
+ +
+

Plugin Docs

+
+ Browse all plugin docs → +
+
+ +

Latest stable release

+ +
+

User Manual

+
Loading…
+
+ Open PDF +
+
+ +
+

Plugin Development Guide

+
+ Open PDF +
+
+ +
+

Plugin Docs

+
+ Browse all plugin docs → +
+
+ +

+ Snapshot docs track the latest snapshot release tag. + Release docs track the latest semantic-version tag (e.g. X.Y.Z). + Both are refreshed automatically by GitHub Actions. +

+ +
+ + + + + + + diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 17462742..91b62a4d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -126,6 +126,12 @@ jobs: echo "cdate=$CDATE" >> "$GITHUB_OUTPUT" # ---------- Publish to gh-pages ---------- + - name: Checkout master for page templates + uses: actions/checkout@v4 + with: + ref: refs/heads/master + path: src_main + - name: Checkout gh-pages uses: actions/checkout@v4 with: @@ -166,211 +172,8 @@ jobs: fi fi - # Write (or refresh) the docs landing page. - cat > _site/docs/index.html <<'HTML' - - - - - -VStar — Documentation - - - - -
-

VStar — Documentation

-

User manual, plugin development guide, and individual plugin docs

- ← Back to VStar Project Hub -
- -
- -

Snapshot (development)

- -
-

User Manual

-
Loading…
-
- Open PDF -
-
- -
-

Plugin Development Guide

-
- Open PDF -
-
- -
-

Plugin Docs

-
- Browse all plugin docs → -
-
- -

Latest stable release

- -
-

User Manual

-
Loading…
-
- Open PDF -
-
- -
-

Plugin Development Guide

-
- Open PDF -
-
- -
-

Plugin Docs

-
- Browse all plugin docs → -
-
- -

- Snapshot docs track the latest snapshot release tag. - Release docs track the latest semantic-version tag (e.g. X.Y.Z). - Both are refreshed automatically by GitHub Actions. -

- -
- - - - - - - -HTML + # Write (or refresh) the docs landing page from the template in master. + cp src_main/.github/pages/docs-index.html _site/docs/index.html # Merge new metadata with existing data/docs.json so a snapshot-only or # release-only run doesn't clobber the other set. From 378d7280df25275c8cdf9a3559e4302b20fe0b33 Mon Sep 17 00:00:00 2001 From: David Benn Date: Thu, 7 May 2026 21:28:10 +0930 Subject: [PATCH 2/2] =?UTF-8?q?#592:=20simplify=20docs.yml=20=E2=80=94=20r?= =?UTF-8?q?emove=20inline=20HTML=20template,=20use=20static=20gh-pages=20f?= =?UTF-8?q?ile?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit docs/index.html now lives directly on gh-pages (like javadoc/index.html), so the workflow no longer needs to check out master or copy a template file. Co-authored-by: Cursor --- .github/pages/docs-index.html | 202 ---------------------------------- .github/workflows/docs.yml | 9 -- 2 files changed, 211 deletions(-) delete mode 100644 .github/pages/docs-index.html diff --git a/.github/pages/docs-index.html b/.github/pages/docs-index.html deleted file mode 100644 index ccef1baa..00000000 --- a/.github/pages/docs-index.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - -VStar — Documentation - - - - -
-

VStar — Documentation

-

User manual, plugin development guide, and individual plugin docs

- ← Back to VStar Project Hub -
- -
- -

Snapshot (development)

- -
-

User Manual

-
Loading…
-
- Open PDF -
-
- -
-

Plugin Development Guide

-
- Open PDF -
-
- -
-

Plugin Docs

-
- Browse all plugin docs → -
-
- -

Latest stable release

- -
-

User Manual

-
Loading…
-
- Open PDF -
-
- -
-

Plugin Development Guide

-
- Open PDF -
-
- -
-

Plugin Docs

-
- Browse all plugin docs → -
-
- -

- Snapshot docs track the latest snapshot release tag. - Release docs track the latest semantic-version tag (e.g. X.Y.Z). - Both are refreshed automatically by GitHub Actions. -

- -
- - - - - - - diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 91b62a4d..a364e915 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -126,12 +126,6 @@ jobs: echo "cdate=$CDATE" >> "$GITHUB_OUTPUT" # ---------- Publish to gh-pages ---------- - - name: Checkout master for page templates - uses: actions/checkout@v4 - with: - ref: refs/heads/master - path: src_main - - name: Checkout gh-pages uses: actions/checkout@v4 with: @@ -172,9 +166,6 @@ jobs: fi fi - # Write (or refresh) the docs landing page from the template in master. - cp src_main/.github/pages/docs-index.html _site/docs/index.html - # Merge new metadata with existing data/docs.json so a snapshot-only or # release-only run doesn't clobber the other set. python3 - "$DATE" \