godot-dlang
godot-dlang copied to clipboard
godot-dlang
Contributing guide
Just something that fleshes out project structure and stuff Maybe some other instructions
I'm currently working on a minimal guide in obsidian format, technically it just a plain markdown pages, but I might use some extra tools to build more convenient visualization such as diagrams or graphs of dependencies.
Though I'm not sure if it worth putting it in the main repo or as dedicated wiki repo, it would be nice to have them here but it might ended up quite heavy on graphics such screenshots or maybe even screencasts.
It could be smarter to have guides in this repo (wiki pages) and all heavy stuff like images/exmaple source code in other repo
Haha yeah, the only problem is to make it work both locally and online ;(
Ok, I'll try to squeeze graphics in 1-2 Mb, but no less than one important screenshot per section.
Maybe then we do everything in separate repo and add it into main as submodule? Then also ofc link in this repo wiki to correct wiki
I know, but We can use github pages for that stuff Personally, github wiki is good for something small, otherwise it's hell to navigate and read imo
And... we're back again on how to host it, so now it seems we now probably better to switch to site generators such as jekyll or whatever else.
But let's start with something first and see how it goes. I'll work on it now and push to your newly created repo when ready.
No idea, personally like I said obsidian is my favorite choice because it is just a markdown with extensions, while on the other hand dealing with hosting involves extra steps.
Anyway we don't have anything yet, and for now I would prefer to stick with plain markdown. I'll start with few chapters that covers the basics then we can decide how to adapt it. readthedocs is ok from usability pov and people often embeds youtube videos, but I have no experience with it.
Hey @al1-ce , can you check https://github.com/godot-dlang/godot-dlang-wiki/pull/1 please?
In guide we refer to contributing.md in this repo which doesn't exist yet. I think we can take ruby on rails document as a starting point and adapt a bit https://github.com/rails/rails/blob/main/CONTRIBUTING.md