{"id":21480281,"url":"https://github.com/dlang/dub-docs","last_synced_at":"2025-07-15T12:31:50.235Z","repository":{"id":33389098,"uuid":"140623473","full_name":"dlang/dub-docs","owner":"dlang","description":"Documentation for the Dub package manager","archived":false,"fork":false,"pushed_at":"2024-08-24T00:32:20.000Z","size":383,"stargazers_count":16,"open_issues_count":32,"forks_count":23,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-08-24T01:38:23.822Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://dub.pm","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dlang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-07-11T20:14:07.000Z","updated_at":"2024-08-24T00:32:23.000Z","dependencies_parsed_at":"2023-11-22T16:28:47.833Z","dependency_job_id":"c043e898-1316-4a61-a218-49ec4840d0ee","html_url":"https://github.com/dlang/dub-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fdub-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fdub-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fdub-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dlang%2Fdub-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dlang","download_url":"https://codeload.github.com/dlang/dub-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226038791,"owners_count":17564046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T12:14:13.161Z","updated_at":"2024-11-23T12:14:13.834Z","avatar_url":"https://github.com/dlang.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"DUB docs\n========\n\nDocumentation for [dub](https://github.com/dlang/dub/) packages, see \u003chttps://dub.pm\u003e.\n\nFor the package registry, see https://code.dlang.org\n\n## Contributing\n\nThe documentation should be written using clear english, preferably avoiding addressing the reader with `\"you\"`, but rather using the passive form.\n\nThe \"dub-guide\" folder (called DUB Guide) should contain quick summaries for the experienced user to quickly look up features, but also for the casual user to understand how most things work. Explanation should be kept short and concise. Whenever there are things that might not be completely clear, example images, CLI output or full project file structures should be provided.\n\nThe \"dub-reference\" folder (called DUB Reference) should contain everything there is to know about DUB for the user. Everything should try to contain example recipes, example code, example output, so users know what to expect using things.\n\nTry not to duplicate information from the guide and the reference, but rather give short summaries in the guide and link to the reference for more in-depth explanation.\n\nThe CLI reference is auto-generated and can be improved by improving the man page generator in the DUB project. (currently the markdown output is not yet PRd / merged into master there, so try to wait a little bit for this first)\n\nThe intro pages should show everything to get started and not much more, to not overwhelm the user.\n\n### Local development\n\nTo work on docs locally:\n\n```\n# you might want to create a virtualenv if you work with python or other mkdocs sites a lot\npython3 -m pip install -r requirements.txt\nmkdocs serve\n```\n\nand to build static pages to distribute:\n\n```\nmkdocs build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlang%2Fdub-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdlang%2Fdub-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdlang%2Fdub-docs/lists"}