Serve the Cerebrium agent skill exactly as cerebrium-skills defines it - #318
Open
mathew-builds wants to merge 7 commits into
Open
Serve the Cerebrium agent skill exactly as cerebrium-skills defines it#318mathew-builds wants to merge 7 commits into
mathew-builds wants to merge 7 commits into
Conversation
Mintlify generates skill.md from the docs pages and serves it at /skill.md and the /.well-known/skills endpoints. The generated file links to no example code and carries no licence. Adding more links to the docs pages would not change that. The examples repository URL already appears 26 times across 19 pages and the generated skill still contains no reference to it, so an override is the only way to surface it. A skill.md at the repository root overrides the generated file. This copies the currently served content verbatim and adds exactly two things: a link to the examples repository under Resources, and license: MIT in the frontmatter. Kept as a single root file rather than a .mintlify/skills/ directory, because multiple skill files turn /skill.md into a redirect to a JSON index, which would break the `npx skills add https://cerebrium.ai/docs` instruction in docs.json.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Replace the root skill.md body with a byte-identical copy of skills/cerebrium/SKILL.md from CerebriumAI/cerebrium-skills, and copy the frontmatter description and license verbatim. Only name and metadata differ, which the sameness check in that repository permits so Mintlify keeps its own keys.
mathew-builds
changed the title
mathew-builds
changed the title
Rule 3 is reworded in CerebriumAI/cerebrium-skills PR #3, which PR #4 deliberately left alone. Once both land, the copy published here would no longer match that repository's master and its sameness check would fail. Rule 3 is taken verbatim from PR #3, relative reference link included. Body is 9002 bytes, sha256 88a723f688f4617766174e56ed42e68c36836c115c3f0a258c2ebc2262a36fe6.
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.
What
Root
skill.mdnow serves the Cerebrium Agent Skill exactly asCerebriumAI/cerebrium-skillsdefines it. Its body is a byte-for-byte copy ofskills/cerebrium/SKILL.mdfrom that repository at commitece67a982675d0a59a52d0d8b6fc455af671068e(sha256962e6b09ca5ab8cba5b83ef88e996efaa1c81eb5ba33c5d4398d019f15793458), with rule 3 taken verbatim fromcerebrium-skillsPR #3, which rewords it.The served body is 9002 bytes, sha256
88a723f688f4617766174e56ed42e68c36836c115c3f0a258c2ebc2262a36fe6. That is the statecerebrium-skillsmaster reaches once PR #3 and PR #4 both land. PR #4 deliberately leaves rule 3 alone so that PR #3 still applies cleanly, so matching PR #3's wording here is what keeps the sameness check green on their master afterwards.This replaces the separate document an earlier revision of this PR added. That document and the skill every marketplace installs were about to be two different things under one name.
CerebriumAI/cerebrium-skillsis the source of truth, and this repository serves it rather than paraphrasing it.Why the copy is exact
tools/check_skill_sameness.pyinCerebriumAI/cerebrium-skills(its open PR #4) fails that repository's CI whenever the two copies drift. It compares the body byte for byte, plus the frontmatterdescriptionandlicense. The frontmatternameand the wholemetadatablock are allowed to differ, because Mintlify needs its own page name and its own metadata keys. Nothing else may differ.name: Cerebriumand themintlify-proj/versionmetadata are kept from the shape Mintlify already deployed green on this branch.descriptionandlicenseare copied verbatim, folded block form and all.Do not edit the body of
skill.mdin this repository. Any reword, reflow, or re-wrap breaks the byte identity and turnscerebrium-skillsCI red. Changes to the skill belong upstream.Merge order
Merge this PR before
CerebriumAI/cerebrium-skillsPR #4. That PR stays red until this one lands, because its checker reads the copy served out of this repository.cerebrium-skillsPR #3 reworks rule 3 and is already reflected here, so the check stays green on their master once both of those land.Michael's ask
Both items are present in the served document:
skill.md:48,https://github.com/CerebriumAI/examplesskill.md:9,license: MITVerification
The upstream checker was fetched at the same pinned commit and run against the bytes this branch serves, with the source as its local side:
The body comparison used to gate this change reports
bodies identical, exit status 0.The checker was also shown not to pass vacuously: changing a single word in the body fails it, re-wrapping two lines without changing any words fails it, and the document this revision replaces fails it, while changing
nameandmetadatastill passes.Two supporting files
Byte identity could not survive on
skill.mdalone, so two other files changed:.prettierignoreexempts/skill.md..github/workflows/build-only.ymlruns Prettier with--writeover**/*.mdon every push and commits the result back. It had already rewrittenskill.mdon this branch once, in commit546c181"Prettified Code!". Without the exemption the next push would silently destroy the byte identity. Verified with the same glob CI uses:prettier --list-different '**/*.md'no longer listsskill.md, andprettier --file-info skill.mdreports"ignored": true.CLAUDE.mdgains a short note markingskill.mdas vendored, so the repo-wide writing rules are not applied to a file that must never be edited here.One known issue is deliberately left alone. Rule 3 links
references/config.mdas a relative path, which resolves to a page that does not exist on the docs site. Fixing it here would break byte identity, so it is registered upstream againstcerebrium-skillsinstead.