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

[docs] Make YAML keys referenceable #4462

Open
romilbhardwaj opened this issue Dec 11, 2024 · 0 comments
Open

[docs] Make YAML keys referenceable #4462

romilbhardwaj opened this issue Dec 11, 2024 · 0 comments

Comments

@romilbhardwaj
Copy link
Collaborator

Our config.yaml page is getting long and it's hard to link to a specific field when sharing docs with users.

We should look into making YAML keys referenceable as clickable links. E.g., ray YAML docs: https://docs.ray.io/en/latest/cluster/vms/references/ray-cluster-configuration.html

We probably don't want to define the YAML keys separately like in the ray docs, but we do want each key to have a hyperlink that can be easily shared.

@Michaelvll Michaelvll added the OSS label Dec 19, 2024 — with Linear
@Michaelvll Michaelvll removed the OSS label Dec 19, 2024
@Michaelvll Michaelvll added the OSS label Dec 19, 2024 — with Linear
@Michaelvll Michaelvll removed the OSS label Dec 19, 2024
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

No branches or pull requests

2 participants