What's so hard to write a proper documentation??

[W01v3n]

Why do you always do the half way??
I tried to install like you instructed in the docs but it just doesn't work because go is not properly configured.
What is so hard to document the things I need to do properly?? There are no right guides out there to install it as you want me to install it, then why?? Please fix your documentations and stop doing it half way.

[paolafrancesca]

@W01v3n I've been patient enough with the attitude you showed in the previous issue, providing you the information you needed regardless of your rudeness.

This rudeness is even stronger here, please behave and follow the code of conduct

Said this: everything can be improved, especially in the docs, but I cannot know upfront what every reader of the documention does not understand if they don't tell me.

So instead of just complaining explain the kind of information you look for and what information it should contain

[W01v3n]

@aspacca Look, I don't mean to be rude. I don't intend on making any of you feel bad in any way, if that's the way you understood it, I'm sorry, really.

There are best practices and many good examples of documentations, ones that the user doesn't need to work himself days in and days out for important things you don't mention.

After being at this thing for days it really feels like whoever wrote the project and the documentation is doing it half way.
And don't think it's coming from someone who is new at this, please no. I work in that field for years, and I just couldn't find what's wrong, because I'm doing everything you say in the documentation.

I don't mean to insult any of you, but if I have to show you every piece of error I get and questions, it'll never end.
The best way to avoid these kinds of situations is simply creating a proper documentation.
And you'll agree with me that the person that created this project will know everything anyone needs to know in order to get it to work. As I'm a developer myself I know that.

For example, you don't explicitly explain that the web frontend is included in the compiled executable, then how should I know it? Should I guess? What? No reasonable person would ever guess that, I never thought that this is even possible!

[paolafrancesca]

@W01v3n 51 contributors, excluding the maintainers, were able to send 100 PRs ca

they evidently found the documentation "proper"

that's for from saying that the documentation cannot be improved, still I have no way to improve it if I'm not told what is lacking by someone that had problem from missing the information he'd expect

For example, you don't explicitly explain that the web frontend is included in the compiled executable, then how should I know it? Should I guess? What? No reasonable person would ever guess that, I never thought that this is even possible!

the only mention to the static front end is below (note the explicit reference to "development" or "custom front end"):

Parameter	Description	Value	Env
web-path	path to static web files (for development or custom front end)		WEB_PATH

You should know because it is not required and so it is not mentioned.
Or better, you should not care, and that's the reason it was not mentioned.

But since you had no idea that static content can be embedded in the compiled executable, you wondered about it.

While the documentation about developing a custom front end is missing, there's a prequired common knowledge that I don't intend to cover in the documentation, unless there will be a huge demand from the community, and only then I will decide if including it or just mention that it's out of the scope of the documentation.

So I renew my request: if you want the documentation to be improved, share what should be the proper content.

$ git clone git@github.com:dutchcoders/transfer.sh.git
Clone in 'transfer.sh' in corso...
remote: Enumerating objects: 14071, done.
remote: Counting objects: 100% (116/116), done.
remote: Compressing objects: 100% (63/63), done.
remote: Total 14071 (delta 70), reused 87 (delta 51), pack-reused 13955
Ricezione degli oggetti: 100% (14071/14071), 33.92 MiB | 8.22 MiB/s, fatto.
Risoluzione dei delta: 100% (6185/6185), fatto.
$ cd transfer.sh
$ go run main.go --provider=local --listener :8080 --temp-path=/tmp/ --basedir=/tmp/
[transfer.sh]2023/02/09 01:02:33 Transfer.sh server started.
using temp folder: /tmp/
using storage provider: local
[transfer.sh]2023/02/09 01:02:33 starting to listen on: :8080
[transfer.sh]2023/02/09 01:02:33 --------------------------
$ go build -o transfersh main.go
$ ./transfersh version
transfer.sh 0.0.0: Easy file sharing from the command line

If you are not able to build/run please provide the information required to reproduce the issue, like the version of go, the operating system, etc etc
This is just a part of the prequired common knowledge that it's out of the scope of the project documentation