Skip to content

Sagemaker docs restructure - #2709

Open
dwarez wants to merge 26 commits into
mainfrom
sm-docs-restructure
Open

Sagemaker docs restructure#2709
dwarez wants to merge 26 commits into
mainfrom
sm-docs-restructure

Conversation

@dwarez

@dwarez dwarez commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Restructure the SageMaker docs landing and navigation: less bloat, clearer page roles, use-case-first entry points. No example or notebook content is touched.

  • Landing page: intro condensed from five paragraphs to two; custom-HTML cards as the entry point (Deploy / Train / DLCs / Reference)
  • Sidebar: Tutorials before DLCs, consistent titles, casing fixes (JumpStart, EC2/ECS/EKS)
  • Tutorials index: link dump → decision table (offering → when to use it → link)
  • New "Set up the SDK" page; setup blocks no longer duplicated across tutorials
  • SDK quickstart is now a real quickstart: deploy a Hub model, invoke, delete (old DistilBERT/IMDb end-to-end recipe removed)
  • Train/Deploy pages: sections ordered by prerequisite, repeated code boilerplate hoisted, Train → Deploy bridge added
  • LLM deployment: TGI section replaced with the vLLM DLC path
  • Removed embedded videos that predate SageMaker SDK v3; fixed broken emoji-anchor links
  • No changes to examples or notebooks

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, or document) 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 source string to a line-array JSON shape (content unchanged). Watch: the same frontmatter block was accidentally prepended to that notebook’s %pip install code 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.

@HuggingFaceDocBuilderDev

Copy link
Copy Markdown

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
dwarez force-pushed the sm-docs-restructure branch 2 times, most recently from b63de55 to c5cde99 Compare August 17, 2026 15:26
@dwarez dwarez changed the title [DRAFT][DOCS] Sagemaker restructure [DRAFT] Sagemaker docs restructure Aug 18, 2026
@dwarez

dwarez commented Aug 27, 2026

Copy link
Copy Markdown
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
dwarez marked this pull request as ready for review August 31, 2026 10:06
@dwarez dwarez changed the title [DRAFT] Sagemaker docs restructure Sagemaker docs restructure Aug 31, 2026
dwarez and others added 20 commits August 31, 2026 12:20
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
dwarez force-pushed the sm-docs-restructure branch from 15c6425 to ab48017 Compare August 31, 2026 10:28
ehcalabres and others added 4 commits August 31, 2026 12:33
Signed-off-by: DWarez <dario.salvati@huggingface.co>
Signed-off-by: DWarez <dario.salvati@huggingface.co>
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.

3 participants