ci(docs): notify thast-docs and modernise architecture diagram#1
Open
FiLORUX wants to merge 2 commits into
Open
ci(docs): notify thast-docs and modernise architecture diagram#1FiLORUX wants to merge 2 commits into
FiLORUX wants to merge 2 commits into
Conversation
Dispatches a docs-update repository event to FiLORUX/thast-docs whenever README.md or LICENSE changes on main, so the docs hub rebuilds without manual intervention. Requires DOCS_DISPATCH_TOKEN repo secret.
Same source renders natively on github.com (mermaid since 2022) and as inline SVG with the Thåst brand palette on docs.xn--thst-roa.se via rehype-mermaid.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ci: notify thast-docs on doc-relevant pushes— adds.github/workflows/notify-docs.yml. On any push tomainthat touchesREADME.mdorLICENSE, posts adocs-updaterepository_dispatch toFiLORUX/thast-docs, which then rebuilds and redeployshttps://docs.xn--thst-roa.se/sptime/.docs: rewrite architecture diagram as mermaid flowchart— replaces the ASCII art block with a ```mermaid flowchart. Renders natively on github.com and as inline SVG with the brand palette on the docs site.Required secret
Before this workflow becomes useful, add a repo secret on
FiLORUX/sptime:DOCS_DISPATCH_TOKENContents: writeonFiLORUX/thast-docsCompanion PR
FiLORUX/thast-docs#4adds the matching sync-docs entry, sidebar group and CI checkout step.Test plan
DOCS_DISPATCH_TOKENis set, push a no-op commit touching README.md and confirm thast-docs rebuildshttps://docs.xn--thst-roa.se/sptime/and verify the page loads with the architecture diagram rendered