Repository navigation
Conversation
The app's MkDocs site duplicated the Hub help center in substratalapps-applications-specs, which every Hub app links to. Its Android-specific content now lives there (CompositeCode/substratalapps-applications-specs branch docs/android-help), so this repo drops site/ and the docs workflow. - HelpLinks opens help/screens/<id>.html in the help center. Screens this app proposes outside the design package (OPS-*) open the help home, since the spec's OPS-* IDs are different, web-only Console screens. - :core:model:exportHelp writes build/help/android.json, the help center's build-status format. help-status.yml opens or updates a PR with it in the specs repo on every merge to main, then sends app-docs-updated. - CI keeps the API coverage check against the pinned openapi/v1 spec. - App version moves to gradle.properties (substratal.appVersion), shared by the APK and the status file. 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.
The app's documentation moves to the Substratal Hub help center in
substratalapps-applications-specs, the one reference every Hub app links to. Companion PR: CompositeCode/substratalapps-applications-specs#4.Changes
site/(MkDocs Material + mike) and.github/workflows/docs.yml. The help center already has guides, per-screen pages, search and a versioned Swagger reference. Android's own content (an Android guide, the help-link contract, per-screen notes) went into the companion PR.HelpLinksopenshttps://compositecode.github.io/substratalapps-applications-specs/help/screens/<id>.html, and the in-app Help topics point at the help center's pages. The Android-onlyOPS-*screens open the help home, because the spec'sOPS-*IDs are now different, web-only Console screens../gradlew :core:model:exportHelp(make help-status) writesbuild/help/android.jsonin the help center's status format. The newhelp-status.ymlworkflow opens or updates a PR with it in the specs repo on every merge tomain, then sendsapp-docs-updated. It needs aSPECS_DOCS_TOKENsecret (Contents and Pull requests read/write on the specs repo).openapi/v1, and drops the docs build.gradle.properties(substratal.appVersion), shared by the APK and the status file.README.mdanddocs/PREREQUISITES.mdare updated, including the open question about Android's Operations section versus the spec's web-only Console.Checked
make api-coverage: all 123 operations the screens call exist in the pinned spec.make help-statusoutput builds cleanly in the help center withHELP_STRICT=1.CI can't run on this account until the GitHub Actions billing issue is fixed.
🤖 Generated with Claude Code