Skip to content

[Doc] uses absolute links for structured outputs#19582

Merged
aarnphm merged 1 commit intovllm-project:mainfrom
aarnphm:fix/docs-invalid-links
Jun 13, 2025
Merged

[Doc] uses absolute links for structured outputs#19582
aarnphm merged 1 commit intovllm-project:mainfrom
aarnphm:fix/docs-invalid-links

Conversation

@aarnphm
Copy link
Copy Markdown
Collaborator

@aarnphm aarnphm commented Jun 12, 2025

This PR updates the absolute links for all structured outputs examples with features page.

I don't think relative links are being resolved correctly here.

Signed-off-by: Aaron Pham contact@aarnphm.xyz

Signed-off-by: Aaron Pham <contact@aarnphm.xyz>
@aarnphm aarnphm requested a review from hmellor as a code owner June 12, 2025 23:46
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@aarnphm aarnphm requested a review from DarkLight1337 June 12, 2025 23:46
@github-actions
Copy link
Copy Markdown

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@aarnphm aarnphm added documentation Improvements or additions to documentation misc structured-output labels Jun 12, 2025
@aarnphm aarnphm enabled auto-merge (squash) June 13, 2025 00:12
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 13, 2025
@hmellor
Copy link
Copy Markdown
Member

hmellor commented Jun 13, 2025

This would mean that all versions will link to the latest version which would break older versions of these examples were ever moved or renamed

@hmellor
Copy link
Copy Markdown
Member

hmellor commented Jun 13, 2025

I think the issue is that the relative links are trying to link to the actual example files rather than the generated example .md pages in the docs.

Does it work if you change the relative links to ../examples/online_serving/structured_outputs?

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

2 similar comments
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@aarnphm
Copy link
Copy Markdown
Collaborator Author

aarnphm commented Jun 13, 2025

Does it work if you change the relative links to ../examples/online_serving/structured_outputs?

I dont' think the reference from features would work, given that we are doing a copy and transpile path from examples -> docs target here.

btw I can't seem to run mkdocs locally to verify this.

@aarnphm aarnphm merged commit 7b3c9ff into vllm-project:main Jun 13, 2025
57 checks passed
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@aarnphm aarnphm deleted the fix/docs-invalid-links branch June 13, 2025 10:24
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 ready ONLY add when PR is ready to merge/full CI is needed structured-output

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants