Repository navigation
Add sfguide-create, sfguide-verify, and sfguide-ship skills - #95
Open
sfc-gh-cnantasenamat wants to merge 4 commits into
Open
sfc-gh-cnantasenamat wants to merge 4 commits into
sfc-gh-cnantasenamat wants to merge 4 commits into
Conversation
verify-sfguide audits, live-tests, and sync-checks a Snowflake developer guide against its companion repo; ship-sfguide runs it, then polishes the guide, adds a pre-review checkpoint, and opens PRs to Snowflake-Labs. Personal accounts, paths, and connections are replaced with placeholders. Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
![snowflake-security-bot[bot]](https://avatars.githubusercontent.com/u/140554735?s=60&v=4){kind=small}
Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
sfc-gh-cnantasenamat
changed the title
Package creation alongside verification and shipping with portable metadata, source-preservation safeguards, and a consistent guide template. Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
sfc-gh-cnantasenamat
changed the title
Share path resolution, Markdown-aware validation, source-bound evidence and exact-file packaging across creation, verification and shipping. Add regression coverage for optional companions/assets, preserved code, stale reports and mismatched releases. Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code) Co-authored-by: Snowflake CoCo <noreply@snowflake.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
1 participant
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
sfguide-create,sfguide-verify, andsfguide-shipworkflow. Creation delivers a labeled draft, verification checks and fixes locally within authorization, and shipping owns approval-gated remote publication. Guides without images, companion repositories, or notebook submissions remain supported.sfguide-verifyfor normalized paths, CommonMark-aware prose checks, optional companion snapshots, local evidence reports, and allowlisted ZIP packaging. All three skills discover this dependency by installed location rather than assuming sibling folders.Test plan
Boundaries
The helper never executes guide code or makes network calls. Manual attestations record caller-supplied evidence; they are not independent proof or tamper-resistant signatures. Synthetic acceptance tests stub link/disclosure evidence and do not establish live publishing success. Ignored companion files and external environment/data changes need explicit manual evidence. The helper compares staged working files, not the Git index; the shipping workflow requires final commit/PR diff review.
Prior work
These skills started in the internal DevRel repository before being prepared for this public submission:
sfguide-createv1.1 (optional feature categories and companion repo link).sfguide-*names, addingsfguide-createandsfguide-ship.sfguide-verifyis new in this PR; it was split out of the shipping workflow.Generated with Snowflake CoCo