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

Where is the package format documentation? #89

Open
CyberShadow opened this issue Mar 13, 2024 · 2 comments
Open

Where is the package format documentation? #89

CyberShadow opened this issue Mar 13, 2024 · 2 comments

Comments

@CyberShadow
Copy link
Member

I remember seeing documentation (for JSON and SDL) describing the dub.json / dub.sdl files.

However, I can no longer find it on dub.pm. Instead, there are now many pages that talk about a lot of things in general terms but seem to be missing descriptions of the file format.

For example, the configurations page at https://dub.pm/dub-reference/configurations/ doesn't actually describe how to define a configuration.

@CyberShadow
Copy link
Member Author

CyberShadow commented Mar 13, 2024

Ah, I found it! They are at

https://dub.pm/dub-reference/package_settings/#configurations

I think there should be a very clear link to that destination from the page describing the configurations.

I have more issues with that:

  • It's not immediately clear to me what Arguments: "<name>" { ... } means. I suggest replacing that with e.g. Syntax: configuration "<configuration-name>" { ... }.
  • It's not immediately clear to me what "build settings" is. I think there should be a link to https://dub.pm/dub-reference/build_settings/.

@CyberShadow
Copy link
Member Author

Could the navigation on the left be split up into categories, so that it's clear which links go to pages that describe syntax, and which go to pages that describe the concepts in general terms?

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