Repository navigation
Use the shared Hub help center instead of a help site in this repo - #2
Merged
Merged
Conversation
The app's documentation moves to the Hub help center in substratalapps-applications-specs (help/), the one reference every Hub app links to. The macOS guide and troubleshooting pages went there in CompositeCode/substratalapps-applications-specs#2; the rest of this repo's Jekyll site duplicated pages that already exist there. - HelpLinks and SubstratalHelpBaseURL point at compositecode.github.io/substratalapps-applications-specs/help/; screen pages are screens/<id>.html. The Help menu gains the macOS guide, Troubleshooting, What's New and API Versioning. - Removes help/, help.yml, help-build.rb and help-generate.rb; sync-openapi.sh vendors only the app's copy of the spec. - CI builds the help center and runs help-check.rb, which fails if any screen in the catalog, Help menu page or #fragment the app opens is missing. - docs-dispatch.yml sends app-docs-updated to the specs repo on every merge to main (needs SPECS_DOCS_TOKEN; otherwise the help center rebuilds daily). - README, CHANGELOG and PREREQUISITES updated. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
What
This app's documentation now lives in the shared Hub help center in
CompositeCode/substratalapps-applications-specs(help/), the one reference every Hub app links to. The macOS-specific pages, Using the Hub on macOS and Troubleshooting, moved there in CompositeCode/substratalapps-applications-specs#2. The rest of this repo's Jekyll site duplicated pages the help center already has (guides, tutorials, FAQ, API reference and versioning), so it's removed here rather than copied.HelpLinksandSubstratalHelpBaseURLpoint athttps://compositecode.github.io/substratalapps-applications-specs/help/; screen pages arescreens/<id>.html. The Help menu adds the macOS guide, Troubleshooting, What's New and API Versioning, and drops Tutorials and Release Notes.help/,.github/workflows/help.yml,scripts/help-build.rb,scripts/help-generate.rb.sync-openapi.shnow vendors only the app's copy of the spec. This repo no longer needs GitHub Pages, which the org's plan doesn't offer for a private repo anyway.help-linksjob builds the help center and runsscripts/help-check.rb. It fails if any of the 75 catalog screens, any Help menu page, or any#fragmentthe app opens is missing.docs-dispatch.yml: on merge tomain, sendsapp-docs-updatedto the specs repo so the help center rebuilds straight away. It needs aSPECS_DOCS_TOKENsecret; without one it skips with a notice, and the help center rebuilds on its daily schedule.Merge order
Merge CompositeCode/substratalapps-applications-specs#2 first. Until it's on the specs repo's
main, the help center (and themacos.html/troubleshooting.htmlpages) isn't published, and thehelp-linksCI job, which builds the specs repo'smain, fails.Verification
Done locally, because Actions jobs on this repo are blocked by the org's billing:
swift test: 15 tests pass, including updated help-link URLs.scripts/help-check.rbagainst a build of the specs PR branch: 75 screens, 10 help links, includingguides/macos.html#keyboard-shortcuts.🤖 Generated with Claude Code