Skip to content

Kernel docs followups#287

Merged
sayakpaul merged 46 commits intomainfrom
kernel-docs-followups
Mar 13, 2026
Merged

Kernel docs followups#287
sayakpaul merged 46 commits intomainfrom
kernel-docs-followups

Conversation

@sayakpaul
Copy link
Member

@sayakpaul sayakpaul commented Feb 17, 2026

  • Move to a fully Jinja-based template and remove re based parsing.
  • Decouple commands into two: kernels init-card and kernels fill-card.
  • Make kernel card generation a part of kernels upload (and test).
  • Add an entry for generating kernel system cards to the "writing kernels" tutorial.

@sayakpaul sayakpaul requested a review from danieldk February 17, 2026 05:32
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@sayakpaul
Copy link
Member Author

@danieldk I have broken the create-and-upload-card command into two simpler commands as we discussed internally. I would like to get a review on the progress made so far before making further changes (docs, etc.).

Would like to open a PR to this PR branch for nix build . so that the card generation process gets included in its execution? That way, once kernels upload is issued, the card also gets uploaded to the build repo.

@sayakpaul sayakpaul marked this pull request as draft February 26, 2026 12:24
@sayakpaul
Copy link
Member Author

@danieldk @drbh a couple of updates here:

  • Broadly, it's now decoupled into two commands: kernels init-card ... and kernels fill-card.
  • Existing user section preserved whilst build-based info is always updated when relevant.

Question:

Do we have to assume "build" directory exists within a kernel source directory? Asking because it seems like we can initialize and serialize the kernel card as "CARD.md" in the top-level kernel source dir and then fill it up based on the information available from build.toml.

@sayakpaul
Copy link
Member Author

I have updated the PR in accordance with #287 (comment).

@drbh @danieldk PTAL when you have time.

danieldk
danieldk previously approved these changes Mar 13, 2026
Copy link
Member

@danieldk danieldk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! One small typo, but good to merge after that.

Co-authored-by: Daniël de Kok <me@danieldk.eu>
@sayakpaul sayakpaul merged commit efbed56 into main Mar 13, 2026
39 checks passed
@sayakpaul sayakpaul deleted the kernel-docs-followups branch March 13, 2026 15:40
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.

4 participants