Hi all, I'm currently working on new revamped DUB documentation, check it out if you want, it currently contains most old documentation plus a big bunch of new documentation:

https://docs.webfreak.org/

Repository: https://github.com/WebFreak001/dub-docs-v2

Instead of being based on diet templates and needing to be compiled using dmd and build all of vibe.d, it now uses mkdocs with a customized mkdocs material theme, so now the documentation is Markdown based, which should be more familiar to a lot of people + it has a great offline search index and a bunch of interactive elements, that also work without JS.

The dub.json and dub.sdl documentation is now merged on the same page, where you can simply swap between them whenever you like. If you have JS enabled it will also sync it across the entire page and persist across page loads.

Writing the docs is really quite easy, you can have it locally be served by first installing the dependencies using

pip install -r requirements.txt

and then when working on it running

mkdocs serve

to have auto-updating docs in the browser. (auto refresh whenever you change anything)

So if you find any typos or want to complete the docs, feel free to open a PR on https://github.com/WebFreak001/dub-docs-v2

I plan to have easily discoverable edit links linked on the page soon too, which should theoretically just be a simple mkdocs configuration thing that's probably already implemented.

Someone from the community has already contributed a dark theme to it. :)

On Monday, 15 August 2022 at 21:32:23 UTC, WebFreak001 wrote:

I like it!

Can anything be done about the width of the buildOptions table though? The whole page takes up about about half of my horizontal screen real estate, yet the "corresponding GDC flags" column is still partially out of view until I scroll right. I'm on a laptop so I can do horizontal scrolls by gesture, but I imagine a user with only vertical scrolling has to navigate all the way down to the bottom of the table to get the horizontal scroll bar to show?

(I don't know how to solve it neatly but I thought I'd mention it.)

On Monday, 15 August 2022 at 21:32:23 UTC, WebFreak001 wrote:

I like the idea, making dub easier to learn for those who are unfamiliar, but I have a singular request: Could you do a section on setting up a copy of dub-registry?

On Monday, 15 August 2022 at 21:32:23 UTC, WebFreak001 wrote:

Looks really great. Thanks for doing this.

On Monday, 15 August 2022 at 21:32:23 UTC, WebFreak001 wrote:

Looks go to be a big improvement.

Some of the paragraphs on this page are a bit long and might need to get broken up.
https://docs.webfreak.org/cli-reference/dub/

On Monday, 15 August 2022 at 21:32:23 UTC, WebFreak001 wrote:

Thank you for doing this!

Not sure if this would be the right place, or if it is addressed already, but I repeatedly find myself looking for the right way to use a local checkout of a package instead of the dub registry, because I keep forgetting. It would be nice to have a section like (assuming I got it right):

Hacking on a local copy of a package

If your project depends on a package in which you have found a problem, or you would like to experiment with changes to it, you can force Dub to use a local copy of the package by following these steps:

1. Fork the git repository
2. Check out a local clone at /path/to/the_package
3. Let Dub know about it:
   dub add-local /path/to/the_package
4. Make Dub ignore any configured release tag, so you'll see the effect of current changes:
   dub add-override the_package * /path/to/the_package

Now you can go ahead and play. Once your PR has been merged and released, or you want to revert to upstream, undo your changes by

5. dub remove-local /path/to/the_package
6. dub remove-override the_package *

-- Bastiaan.

On Thursday, 18 August 2022 at 10:23:35 UTC, Bastiaan Veelo wrote:

You can also simply to modify the tree in .dub or %appdata% and afterwards copy-paste the change to a git clone. It's more dangerous, but I think it's more straighforward too.