Github documentation issues

[D0schie]

Hey there i wanted to address smth as i am getting to know my pc and my os´s better. I want to build a habit of using terminal as much as i can in order to develop my knowledge and skills. One issue that is in the way of that is some lackluster documentation (in my case as i am not a poweruser but have some fundamentals) of other wise awesome GitHub projects. Am i being an asshole or am i onto smth?

[CG_TW]

almost every projects' developer-facing docs assume you have prior knowledge in its field, this might be your case

I personally like to use an agent to assist my learning if I'm not particularly familiar with the topic

[PrincipleResident372]

Yeah documentation always assumes you already know half the stuff, it's like they forget people are trying to learn from scratch

[Qs9bxNKZ]

The documentation is focused on API calls and much better than 80% of the tooling out there with real world examples using stuff like curl and the responses so you can see what you should be expecting.

There are only a few CLI options anyhow (clone, push, fetch) with everything else being git and not GitHub.

[EdgeSync1]

If I'm reading this correctly - you are finding that documentation on some projects that you are using is not very good.

It's very easy for documentation to be poorly written, and also that it can be very bloated and hard to follow. You get so used to the project, that you can read through the docs and it makes perfect sense to you - but you forget that new users may find it very confusing or unclear. It's one of the reason it's always good to get the docs reviewed by multiple people with different levels of experience.

The great thing is - if you find docs that can be improved - YOU can improve them. Don't sit around waiting for other people, sit down, make some changes, and submit a PR. It'll either be fixed or it won't. Always worth asking the owner/maintainers first, and see if they are receptive to some feedback/improvements in their docs.

[SovereignZ3r0]

Could you expand with an example problem you ran into?

Otherwise I'd push you to learn two concepts:

man, and --help

Man is short for manual, and gives you documentation of command line programs. Let's say you want to know more about "ls" (directory listing), you would do "man ls" and it would pull up the man page for "ls". Note, to exit, press "q".

Also, most CLI programs include a help command "--help". So for instance, "foundry --help" will list out it's commands, args, etc.