Init, fill, and check so empty help cannot ship quietly - #1
Merged
Conversation
Give developers a shaped help.sdl, a questionnaire, and a --strict CI gate (reusable workflow) instead of parse-success on empty docs. Co-authored-by: Cursor <cursoragent@cursor.com>
After the July transfer, dev-centr/prohelp redirects but the canonical repo for check-schema.yml callers is openshellorg/prohelp. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.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
2 participants
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
Hi! Parse-success on a blank
help.sdlwas letting people think they had a working Prohelp system when the fields that actually make help useful were still empty.This PR tries to give authors a loop they can run locally and a ship gate they can opt into:
prohelp initwrites a shaped schema immediately (questionnaire is optional:--fillorprohelp fill)prohelp checkreports missing summaries, discovery URLs, empty sections, and budget slips;--strictfails for CI.github/workflows/check-schema.ymlso other repos can call one job instead of inventing the pipelineexampletags are parsed and shown in Text Mode (they used to be ignored)checkstill cannot reach into someone else's CI by itself — they add the job. The workflow is the one-liner for that.Happy to adjust anything that doesn't fit the project's taste.
How to try it
dub build -c executableprohelp init --name myappthenprohelp check/prohelp check --strictprohelp fill help.sdl --set summary=Does a thing --set homepage=https://example.com --set docs=https://example.com/docs --set issues=https://example.com/issuesprohelp help.sdl ?Made with Cursor