Sagemaker docs restructure - #2709
Open
dwarez wants to merge 26 commits into
Open
Conversation
|
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. |
dwarez
force-pushed
the
sm-docs-restructure
branch
2 times, most recently
from
August 17, 2026 15:26
b63de55 to
c5cde99
Compare
Contributor
Author
|
@ehcalabres let me know if you think we can un-draft the PR, or if you have additional content you want to add 👀 |
dwarez
marked this pull request as ready for review
August 31, 2026 10:06
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Before it was like an example, which was too much Signed-off-by: DWarez <dario.salvati@huggingface.co>
the purpose of each section clear Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
but only store for reference?) Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
currently they're super ugly) Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
dwarez
force-pushed
the
sm-docs-restructure
branch
from
August 31, 2026 10:28
15c6425 to
ab48017
Compare
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
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
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.
Restructure the SageMaker docs landing and navigation: less bloat, clearer page roles, use-case-first entry points. No example or notebook content is touched.
Signed-off-by: DWarez dario.salvati@huggingface.co
Note
Low Risk
Documentation and notebook metadata only; the mistaken frontmatter in one pip cell is a localized runnable-notebook bug, not a production code risk.
Overview
This slice of the SageMaker docs restructure tags several SDK tutorial notebooks with HTML-comment frontmatter (
category: embeddings,text-generation, ordocument) at the top of the intro markdown cell, so the docs site can group notebooks by use case.The async inference + TEI notebook also normalizes its opening markdown from a single
sourcestring to a line-array JSON shape (content unchanged). Watch: the same frontmatter block was accidentally prepended to that notebook’s%pip installcode cell, which would break the prerequisites cell if a reader runs it as-is.Other notebooks in the diff only add the category block to the first markdown cell; tutorial prose is otherwise untouched.
Reviewed by Cursor Bugbot for commit 9d215d3. Bugbot is set up for automated code reviews on this repo. Configure here.