Fix cookbook index: repair two dangling recipe links - #556
Open
claudespice wants to merge 1 commit into
Open
Conversation
Both links in the root README index 404 on GitHub: - ./imap/outlook.md - added by spiceai#76, but the file (and imap/spicepod.outlook.yaml) was deleted in spiceai#139. The sub-bullet was left behind; imap/ now contains only README.md and spicepod.yaml. - ./vectors/s3-vectors/README.md - that directory has never existed. The recipe lives at vectors/s3/, so the path was wrong from the commit that added it.
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.
Found by sweeping every relative Markdown link in the repo against the filesystem. Two entries in the root README index point at paths that do not exist, so both 404 on GitHub.
./imap/outlook.mdThe sub-page was added in #76 and then deleted in #139 (
docs: IMAP outlook), which removed bothimap/outlook.mdandimap/spicepod.outlook.yaml:imap/now contains onlyREADME.mdandspicepod.yaml, and the README has no Outlook content to redirect the link to — so the dangling sub-bullet is removed../vectors/s3-vectors/README.mdvectors/s3-vectors/has never existed in the repo's history — the recipe is atvectors/s3/. The wrong path was introduced by the same commit that added the index entry, so this link has never resolved. Corrected to./vectors/s3/README.md.What changed
imap/outlook.mdsub-bullet./vectors/s3/README.mdAfter this change, every relative link in the root README resolves (verified by re-running the sweep: 0 remaining).
Separate finding, not fixed here
The same sweep shows 16 recipe directories that have a README but are not linked from the root index, so they are effectively undiscoverable:
I have not added these, because it is an editorial call I would rather leave to you — in particular
mysql/cdcandserializable-transactionsdocument features targeting the unreleasedv2.2.0+, so they may be intentionally unlisted. Happy to open a follow-up adding the rest if you want them indexed.