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

Provide a directive to link the documentation on the registry #2931

Open
schveiguy opened this issue Jun 13, 2024 · 0 comments
Open

Provide a directive to link the documentation on the registry #2931

schveiguy opened this issue Jun 13, 2024 · 0 comments

Comments

@schveiguy
Copy link
Member

schveiguy commented Jun 13, 2024

The dub registry currently has a "setting" that you must add at the registry in order to add a documentation link.

Following the precedent of the "homepage" and "description" directives, neither of which factor into building but are exclusively for the registry, I propose the dub file add a new directive "onlineDocumentation" which consists of a URL to use for documenting a package. This way, we don't need that extra setting, and running e.g. a CI script to build the appropriate docs, deploy, and update the json file is all doable without dealing with APIs of dub registry.

In fact, I would like to see all the configuration of the registry package (logo, categories, etc.) aside from the fundamental permissions and repository link be put into the dub file. But for now I think the documentation is the most obvious one.

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

1 participant