test: validating automated test suite - #941
Closed
chittolinag wants to merge 7 commits into
Closed
Conversation
superdoc-bot Bot
pushed a commit
that referenced
this pull request
Jul 29, 2026
Moving a demo or example directory breaks every GitHub link already published, because GitHub only leaves redirects behind for repository renames, not for paths inside a repository. Today the only fix is a stub README left at the old path, and seven of those already exist. This adds a `slug` field to catalog entries: the permanent public name a demo is reachable by at go.superdoc.dev, independent of where its source currently lives. It stays separate from `id` because `id` is the internal catalog key and should stay free to follow section renames, while a public slug cannot move without breaking links we do not control. Slugs are opt-in, so nothing is published until it has earned a permanent name, and 26 entries are named here to start. The validator rejects duplicates, non-kebab-case names, names that would shadow a service route, and slugs on entries we have deliberately withdrawn. The service that serves those URLs is superdoc/linkkeeper, a separate project. It reads these manifests directly, so publishing an example is just the slug edit and there is no second list to keep in sync. The workflow added here only tells it when the catalog changed, and it lives in the public repo rather than in Orbit's export pipeline: the export pushes straight to public main, so by then the manifests are already public and the SHA is the exported one. The catalog had no CI gate on this branch, so metadata validation now runs in its own fast workflow rather than inside the demo build. Note: this ports only the public subtree changes from a mixed source commit (12 public paths, 2 non-public paths ignored). Ported-From-Source-Repo: superdoc/orbit Ported-From-Source-Commit: ef3e82021629254753918e6b0ad8d9c3d54c0d4f Ported-Public-Prefix: superdoc/public
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.
No description provided.