Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix incorrect links in documentation #1481

Merged
merged 8 commits into from
Sep 21, 2024

Conversation

rchen19
Copy link
Contributor

@rchen19 rchen19 commented Sep 21, 2024

Motivation

Some links on current Documenation contains links that are actually file path in the repository, e.g., https://sglang.readthedocs.io/en/latest/backend.html#docs/en/custom_chat_template.md, which should be pointing to the file docs/en/custom_chat_template.md in the repo, but on the website, clicking on the link will not take you anywhere.

Modifications

Change the links that contain file paths to full URL pointing to github readthedocs pages, e.g., change docs/en/custom_chat_template.md to https://github.com/sgl-project/sglang/blob/main/docs/en/custom_chat_template.md

`here <https://sglang.readthedocs.io/en/latest/custom_chat_template.html>`

Checklist

  • Format your code according to the Contributor Guide. No code changes
  • Add unit tests as outlined in the Contributor Guide. No need for tests since there is no code change
  • Update documentation as needed, including docstrings or example tutorials. This PR is purely about documentation

- llama2.py --> llama.py
- because on deployed document website clicking link containing path will not take you to the file
srt_example_llava.py do not exist
docs/en/backend.md Outdated Show resolved Hide resolved
- only for the ones that can be pointed to a readthedocs page
docs/en/backend.md Outdated Show resolved Hide resolved
docs/en/backend.md Outdated Show resolved Hide resolved
docs/en/backend.md Outdated Show resolved Hide resolved
docs/en/backend.md Outdated Show resolved Hide resolved
@zhyncs zhyncs merged commit ce636ac into sgl-project:main Sep 21, 2024
1 check failed
@zhyncs
Copy link
Member

zhyncs commented Sep 21, 2024

@rchen19 Thanks for your contribution!

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