Skip to content

Fix cookbook index: repair two dangling recipe links - #556

Open
claudespice wants to merge 1 commit into
spiceai:trunkfrom
claudespice:claude/fix-readme-dangling-links
Open

Fix cookbook index: repair two dangling recipe links#556
claudespice wants to merge 1 commit into
spiceai:trunkfrom
claudespice:claude/fix-readme-dangling-links

Conversation

@claudespice

Copy link
Copy Markdown
Contributor

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.md

- [IMAP Data Connector](./imap/README.md) - Connect to an IMAP email server.
  - [Connecting to an Outlook mailbox](./imap/outlook.md)

The sub-page was added in #76 and then deleted in #139 (docs: IMAP outlook), which removed both imap/outlook.md and imap/spicepod.outlook.yaml:

$ git show --stat d9852c0
 imap/outlook.md            | 115 ---------------------------------------------
 imap/spicepod.outlook.yaml |   8 ----

imap/ now contains only README.md and spicepod.yaml, and the README has no Outlook content to redirect the link to — so the dangling sub-bullet is removed.

./vectors/s3-vectors/README.md

- [Amazon S3 Vectors](./vectors/s3-vectors/README.md) - Use S3 as a vector engine for embeddings and similarity search.

vectors/s3-vectors/ has never existed in the repo's history — the recipe is at vectors/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

  • Removed the dangling imap/outlook.md sub-bullet
  • Repointed the Amazon S3 Vectors entry to ./vectors/s3/README.md

After 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:

acceleration/cron          catalogs/postgres     mongodb/change-streams   search/elasticsearch
catalogs/ducklake          elasticsearch/connector   mtls                 serializable-transactions
catalogs/mssql             mcp-server            mysql/cdc                snowflake/dml
catalogs/mysql             client-sdk/spice-dotnet-sdk-sample   postgres/cdc   vectors/s3 (fixed above)

I have not added these, because it is an editorial call I would rather leave to you — in particular mysql/cdc and serializable-transactions document features targeting the unreleased v2.2.0+, so they may be intentionally unlisted. Happy to open a follow-up adding the rest if you want them indexed.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant