feat(integrations): add validation framework and 21 integration guides - #34
Conversation
…movement guides Signed-off-by: James Kurz <255140170+jameskurz-filecoin@users.noreply.github.com>
Signed-off-by: James Kurz <255140170+jameskurz-filecoin@users.noreply.github.com>
Signed-off-by: James Kurz <255140170+jameskurz-filecoin@users.noreply.github.com>
Signed-off-by: James Kurz <255140170+jameskurz-filecoin@users.noreply.github.com>
|
@jameskurz-filecoin is attempting to deploy a commit to the Filecoin Foundation's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@filipagr, when you have a chance, could you review the integration structure, customer-facing status language, and navigation/LLM mirrors? All 21 guides remain explicitly Not currently tested. The production build passes locally; Vercel currently requires a team member to authorize the fork preview. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
filipagr
left a comment
filipagr
left a comment
There was a problem hiding this comment.
Reviewed the new integration-docs framework and all 21 guides — the content and structure are consistent (frontmatter/status/sidebar/mirror all line up, Snowflake is confirmed absent as intended). Two small logic gaps in scripts/check-integrations.mjs itself, both cheap to fix since this PR is the checker's debut — suggestions inline below. Neither affects the 21 guides in this PR (they all pass today); they'd only bite on a future Verified or Not currently supported guide.
| const field = value(key); | ||
| if (!field || field === "[]" || field === "null") failures.push(`${file}: Verified requires ${key}`); | ||
| } | ||
| if (!/^\[[^\]]+\]$/.test(value("tested_versions") ?? "")) failures.push(`${file}: Verified versions must be a non-empty inline list`); |
There was a problem hiding this comment.
A whitespace-only list like tested_versions: [ ] passes this check, since [^\]]+ matches a lone space. Requiring at least one non-whitespace character inside the brackets closes that:
| if (!/^\[[^\]]+\]$/.test(value("tested_versions") ?? "")) failures.push(`${file}: Verified versions must be a non-empty inline list`); | |
| if (!/^\[[^\]]*\S[^\]]*\]$/.test(value("tested_versions") ?? "")) failures.push(`${file}: Verified versions must be a non-empty inline list`); |
There was a problem hiding this comment.
Taken. Whitespace-only lists now fail, same as your suggestion.
| if (status !== "Verified" && /(^|\W)Verified(\W|$)/.test(body)) { | ||
| failures.push(`${file}: body uses Verified without Verified metadata`); | ||
| } | ||
| if (status && !blocked) { |
There was a problem hiding this comment.
This skips the "body must contain exactly one matching Validation status: line" check for blocked (Not currently supported) guides, so a blocked guide's body could omit the status line entirely or claim a different status and the checker wouldn't catch it. Dropping the !blocked exemption applies the same consistency rule uniformly:
| if (status && !blocked) { | |
| if (status) { |
There was a problem hiding this comment.
Taken. Blocked guides now have to carry the same Validation status line as the others.
|
@jameskurz-filecoin preview link: https://filone-docs-git-fork-james-d424c1-filecoin-foundations-projects.vercel.app/ Left two small suggestions on Quick question: is the plan to run the live validation scenarios before this merges to production, or merge with guides staying |
Reject whitespace-only tested_versions lists, and require a Validation status line on blocked guides as well as live ones.
Setup guides should read like setup guides. Status stays in frontmatter and the checker still refuses Verified without evidence.
|
@filipagr should def not be on the live guides — I checked and none of our competitors do that. Really good catch. Let's merge without waiting to run every tool ourselves. I'm taking those banners off the pages and the status column off the index so they read as setup guides. We still won't mark anything verified unless we've actually run it (version, regions, date, evidence) — your checks stay for that. If something really doesn't work, we'll say so on that page. Pushed the copy change here. |
2 participants
References FIL-971.
Adds setup guides for 21 tools (rclone, backup/NAS, Kubernetes/DevOps, data/AI) plus shared connection settings. Snowflake is still omitted.
Pages are how-tos: endpoint, path-style, example commands. Nothing is marked verified unless we have a named version, regions, date, and evidence.