Skip to content

[docs] Refactor get started section - #14783

Merged
stevhliu merged 3 commits into
huggingface:mainfrom
stevhliu:get-started
Sep 17, 2026
Merged

stevhliu merged 3 commits into
huggingface:mainfrom
stevhliu:get-started

Conversation

@stevhliu

Copy link
Copy Markdown
Member

Refactors and updates the Get Started section to match Diffusers better, get to generating an image faster, and be more agent-ready:

  • index.md now includes Modular Diffusers and adds a "Where next" section to help guide users
  • installation.md updates Python version, drops stale Windows version note
  • quicktour.md is trimmed down a bit to be less explanatory and more getting to the point
    • adds an agent prompt block to help users using agents get started
    • shrinks the DiffusionPipeline section, updates LoRA, merges the quantization/optimization section together
    • rely on links where appropriate to guide the user deeper
  • cli.md does some basic cleanup to split dense sections

@github-actions github-actions Bot added size/L PR with diff > 200 LOC documentation Improvements or additions to documentation and removed size/L PR with diff > 200 LOC labels Sep 15, 2026
@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.

@sayakpaul sayakpaul left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice, thanks! Pretty nice.

Comment thread docs/source/en/using-diffusers/cli.md
Comment thread docs/source/en/using-diffusers/cli.md Outdated
Remote flags:

- `--flavor <name>` — sandbox hardware (e.g. `a10g-small`, `h200`, `rtx-pro-6000`).
- `--flavor <name>` — sandbox hardware (`a10g-small`, `h200`, `rtx-pro-6000`).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What's wrong with "e.g."? From the current change, it looks like those are the only two flavors that we offer from the HF Jobs and that is not the case.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

i tend to avoid "e.g" and "i.e" and spell it out because its clearer (adopted from the Google style guide).

updated this to say "for example" so it doesn't look like we only offer those flavors

Comment thread docs/source/en/index.md
Comment thread docs/source/en/quicktour.md Outdated
Comment on lines +44 to +48
```text
prompt -> text encoder -> embeddings -+-> UNet/DiT <- scheduler ====xN====
noise --------------------------------+ |
latents -> VAE -> image
```

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can remove this and replace this with a nice animation or a simple infographic. All our favorite agents are pretty good at generating those at this point.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

i've actually been favoring the simplicity of small/minimal ASCII diagrams like this because they're easier to update and maintain, and more readable for any agents reading the docs!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Okay in that case, I would have to say that I don't find the ascii diagram to be adding any additional useful info. So, I would remove it. The docs are also for humans to review (IMO, ascii figures are hard for human to parse) and let's not forget that :)

@github-actions github-actions Bot added the size/L PR with diff > 200 LOC label Sep 16, 2026
@stevhliu
stevhliu merged commit 37ce5ad into huggingface:main Sep 17, 2026
6 checks passed
@stevhliu
stevhliu deleted the get-started branch September 17, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/L PR with diff > 200 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants