Skip to content

ci(*): automate docs publishing#151

Merged
vdice merged 5 commits intospinframework:mainfrom
vdice:ci/docs
Apr 15, 2026
Merged

ci(*): automate docs publishing#151
vdice merged 5 commits intospinframework:mainfrom
vdice:ci/docs

Conversation

@vdice
Copy link
Copy Markdown
Contributor

@vdice vdice commented Apr 14, 2026

  • Adds a docs.yml workflow to publish (re-)generated docs to a gh-pages branch: 1170372
  • Updates the generate_docs.py script to take in a versioned folder arg (eg v4 or the canary default): e9ec38f
  • Updates the script to (re-)write an index.html file at root to redirect to the most recent major version (using the same arg as above, when in v* form): 8048880
  • Removes docs/ and adds this folder to .gitignore: 1730e61

TODO:

  • actually create the gh-pages branch seeded with docs/{v1-v4} folders
    • Note: currently not planning to bring over html files outside of a versioned subfolder (today they appear to represent v2 docs); with the intention that the only such file will be the redirect root index.html

Tested on my fork:

Closes #141

vdice added 4 commits April 14, 2026 16:33
Signed-off-by: Vaughn Dice <vdice@akamai.com>
Signed-off-by: Vaughn Dice <vdice@akamai.com>
Signed-off-by: Vaughn Dice <vdice@akamai.com>
Signed-off-by: Vaughn Dice <vdice@akamai.com>
@vdice vdice requested review from dicej and karthik2804 April 14, 2026 22:43
Copy link
Copy Markdown
Collaborator

@dicej dicej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Would you mind removing the docs/** linguist-generated=true line from .gitattributes, also, since it's no longer needed?

Comment thread CONTRIBUTING.md Outdated
Signed-off-by: Vaughn Dice <vdice@akamai.com>
@vdice vdice merged commit 396d219 into spinframework:main Apr 15, 2026
2 checks passed
@vdice vdice deleted the ci/docs branch April 15, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a CI check to verify docs are up-to-date

2 participants