Clearer explanations of components & structure in guides #362
Closed
Jensby
started this conversation in
Documentation
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Hi, I would really like it if the documentation had a little clearer explanations of the different components, especially in describing what the component does specifically and how to use it. It would save me and others a lot of time and confusion and could save you some time from having to answer all my dumb questions
Take this as an example:
https://fish-networking.gitbook.io/docs/manual/components/prediction/predictedobject
It tells me what the term "predicted object" means, and shortly what the PredictedObject component is responsible for, but I don't know what it actually does, eg. what happens when I add it to an object, or how to use it properly.
A lot of the component pages I've read are like this. Would be really nice with a comprehensible summary at the top of each component of what it does, what to use it for, and how to use it.
The guides would also read much more easily if they had some points/headers for different steps, and perhaps a little summary at the top too. Trying to comprehend the "Using Client-Side Prediction" guide is a bit difficult for me, because it jumps into code really fast before I know why or what's even going on, and I don't know where to skip to, to find the information that I need, and then it becomes stressful to try to keep track of what's going on, while also trying to understand a new concept and how to implement it.
Cheers
Beta Was this translation helpful? Give feedback.
All reactions