This project needs serious documentation

[kopeek]

Is your feature request related to a problem? Please describe.
You should comment every option that you have, so people know how to use it, or why They should use it instead of making on your own. This is CRUCIAL for this project, because people will know why this project is very helpful.

Describe the solution you'd like
add every description to your docs. and from now, and during making new features add description od documentation to them so it won't take a lot of time

Describe alternatives you've considered
I think that adding to documentation will be the fastest method

Additional context
Add any other context or screenshots about the feature request here.

[ninetailsrabbit]

I am well aware of this but I still have to finish other work on other projects and my time is limited.

There is too much in this repository to have a documentation ready in the short term but I do not rule out adding the missing parts in my spare time.

[officialduke99]

Hi, I've been watching this project lately and find it very useful. It not only adds a ton of things I'm missing in vanilla empty Godot projects, it also has a very nice code style, structure and goes in line with most of the GDScript or general programming best practices. I would like to offer help with programming tasks ideally, but if you don't need any help with that at the moment, I can also work on the documentation.

But for that, I would need to know. Do you have a preferred way to create the documentation? Will you want it to be in wiki, markdown files or (my personal preference) GDScript Docstrings?

[ninetailsrabbit]

Hi, I've been watching this project lately and find it very useful. It not only adds a ton of things I'm missing in vanilla empty Godot projects, it also has a very nice code style, structure and goes in line with most of the GDScript or general programming best practices. I would like to offer help with programming tasks ideally, but if you don't need any help with that at the moment, I can also work on the documentation.

But for that, I would need to know. Do you have a preferred way to create the documentation? Will you want it to be in wiki, markdown files or (my personal preference) GDScript Docstrings?

Hi @officialduke99 I appreciate your kind words, I try to make the elements of the template not to influence the final logic of the player game and to make them easy to remove and put back.

I still have to add some new things to this template that I have recently discovered before finishing the documentation that change some things that exist.

In any case, I've notice that some of the popular repositories are using mdBook and the final result looks pretty good. We can use the github pages to host and display it

As soon as I'm done, I'll open some issues where outsiders like you can help.

Thanks in advance!

[officialduke99]

I was thinking something more along the lines of gdscript-docs-maker, which can also probably be hosted through pages with the added benefit of using the gdscript docstrings for generating code reference. In my opinion, this would be really nice, as you have the offline docs on hand in any project using the template and the documentation is right next to the relevant functions and variables, thus making it easier to edit, when code changes. The only downside I've seen is that it can make the code a bit less readable, as docstrings spread out the functions and variables further apart, but they can be collapsed in the code editor.

[kopeek]

Let's just use default Github pages to show it

[kopeek]

or just in the readme file
for the start it's good

[QuotientParadox]

me too, I don't get this project

[QuotientParadox]

Wait, would a few text files be good for contribution?

[kopeek]

maybe

Wait, would a few text files be good for contribution?

[QuotientParadox]

maybe

Wait, would a few text files be good for contribution?

I am asking the creator, not you, however I appreciate your comment

[ninetailsrabbit]

Wait, would a few text files be good for contribution?

Don't worry about that, there are a lot of changes since I wrote the README so it's basically up to me because I understand what the code does exactly

[Sharaf5]

Think one video is better and could spreed this project much as the project is meant for modifications not for direct usage
I with I could understand all of your project structure as it's not self explanatory
By the way, your project is pretty helpful, thanks