Skip to content

Conversation

petecheslock
Copy link
Collaborator

This PR migrates the user guide section to use remote content from the llm-d-incubation/llm-d-infra repository, ensuring the documentation stays in sync with the source of truth.

✨ Changes

  • 🏠 Guide landing page β†’ syncs from quickstart/examples/README.md
  • πŸ“‹ Prerequisites page β†’ syncs from quickstart/README.md
  • πŸ›€οΈ Well-lit paths β†’ syncs from individual example READMEs:
    • Inference Scheduling
    • Prefill-Decode Disaggregation
    • Wide Endpoint LWS

πŸ”§ Technical Updates

  • βž• Added 5 new remote content sources in remote-content/remote-sources/
  • 🚫 Updated .gitignore to exclude auto-generated remote files
  • πŸ”— Fixed link transformations and anchor references for Docusaurus compatibility
  • πŸ—‘οΈ Removed local guide.md and prerequisites.md (now auto-generated)

🎯 Benefits

  • πŸ“„ Documentation automatically stays current with llm-d-infra updates
  • πŸ”— Source attribution with edit links back to original repository
  • πŸš€ Reduced maintenance overhead for guide content

- Added new guide-related files to .gitignore for remote content integration.
- Removed local `arch.jpg` and `quickstart.md` files as they are no longer needed.
- Introduced new remote content sources for guide examples, prerequisites, inference scheduling, and more to enhance documentation.

Signed-off-by: Pete Cheslock <[email protected]>
@petecheslock petecheslock requested a review from jjasghar July 29, 2025 16:24
Copy link

netlify bot commented Jul 29, 2025

βœ… Deploy Preview for elaborate-kangaroo-25e1ee ready!

Name Link
πŸ”¨ Latest commit
πŸ” Latest deploy log https://app.netlify.com/projects/elaborate-kangaroo-25e1ee/deploys/6888f638f2300d2c5a765241
😎 Deploy Preview https://deploy-preview-69--elaborate-kangaroo-25e1ee.netlify.app
πŸ“± Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@petecheslock
Copy link
Collaborator Author

All the files within https://deploy-preview-69--elaborate-kangaroo-25e1ee.netlify.app/docs/guide are updated to point to the quickstarts. @Gregory-Pereira You might be interested in this as well - we are autosyncing the quickstart guides from the llm-d-infra project to the userguide on llm-d.ai

@jjasghar jjasghar merged commit 45b6cab into llm-d:main Jul 29, 2025
1 of 5 checks passed
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.

2 participants