Skip to content

#592: add docs.yml workflow and update Help.java URLs to github.io#594

Merged
dbenn merged 2 commits into
masterfrom
592-document-deployment-to-githubio
May 7, 2026
Merged

#592: add docs.yml workflow and update Help.java URLs to github.io#594
dbenn merged 2 commits into
masterfrom
592-document-deployment-to-githubio

Conversation

@dbenn
Copy link
Copy Markdown
Collaborator

@dbenn dbenn commented May 7, 2026

  • New .github/workflows/docs.yml publishes user manual and plugin PDFs (snapshot and release) to gh-pages under docs/vstar/{snapshot,release}/
  • docs/index.html is written by the workflow on each run
  • Help.openVStarManual() and openPluginHelp() base URL updated from GitHub blob/tree URLs to https://aavso.github.io/VStar/docs/vstar/release/ so PDFs open natively in the browser

- New .github/workflows/docs.yml publishes user manual and plugin PDFs
  (snapshot and release) to gh-pages under docs/vstar/{snapshot,release}/
- docs/index.html is written by the workflow on each run
- Help.openVStarManual() and openPluginHelp() base URL updated from
  GitHub blob/tree URLs to https://aavso.github.io/VStar/docs/vstar/release/
  so PDFs open natively in the browser

Co-authored-by: Cursor <cursoragent@cursor.com>
@dbenn dbenn requested a review from mpyat2 May 7, 2026 07:54
@dbenn dbenn self-assigned this May 7, 2026
@dbenn dbenn added the documentation Improvements or additions to documentation label May 7, 2026
@dbenn dbenn linked an issue May 7, 2026 that may be closed by this pull request
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Plugin Unit Tests

All tests passed (Java 17)

Metric Value
Tests 1
Passed 1
Failures 0
Errors 0

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

VStar Unit Tests

All tests passed (Java 17)

Metric Value
Tests 879
Passed 879
Failures 0
Errors 0

@dbenn
Copy link
Copy Markdown
Collaborator Author

dbenn commented May 7, 2026

Hi @mpyat2 Please see the related issue #592

My aim here is to add to the GitHub.io page the latest stable and snapshots docs and to point to them in VStar for a better experience of PDF rendering, so the key bits are a workflow (action) and a change to the help and plug-in doc URLs in https://github.com/AAVSO/VStar/pull/594/changes#diff-d8a21798b82464cb690bae4f7a37a0dd20b706760977ac4e8f07e92e1ac9054d

It's mostly the Help.java change that I want you to be aware of. The workflow may take some iterating to get right but I think it will be OK.

I'm not sure whether you are aware of the work I've been doing to create https://aavso.github.io/VStar/

The next use to which In want to put the GitHub.io space is as the target for the Plug-in Manager: #589

That will give us control over release-time update of plugins, so we won't need to burden AAVSO HQ with a deployment step.

Let me know what you think.

The workflow file hasn't been merged to master yet, so it won't be available in the Actions tab until the PR is merged. Once it's merged, we can either wait for the next release to fire it automatically, or trigger it manually.

@mpyat2
Copy link
Copy Markdown
Collaborator

mpyat2 commented May 7, 2026

I think it's a great thing

@dbenn dbenn merged commit e5b3d88 into master May 7, 2026
20 checks passed
@dbenn dbenn deleted the 592-document-deployment-to-githubio branch May 7, 2026 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document deployment to github.io

2 participants