SpongeDocs
SpongeDocs copied to clipboard
SpongePowered
Document how DataSerializable and TypeSerializer stuff serializes to config
Making an issue here so that discussion on this can be done here instead on the forums.
Link with idea: https://forums.spongepowered.org/t/lets-get-chat-formatting-right/12613/17?u=katrix
Copy-Paste from thread:
The second thing I think we need to think about is a bit documentation. I'm not talking about plugin documentation or developer documentation. What I've more referring to here is documentation of things like TextTemplate and Text that players will see again and again in their configs. I don't know how far we should go with this, but I feel like we need some central place where players can understand how Text and TextTemplate works, not just from a development standpoint, but also from an user standpoint.
So basically, we need to look at how we can help users not feel alienated and confused when they open up the config and see lots of stuff that they have no idea what does. I think the docs would be a nice place for this as it should be consistent between plugins.
This could use a more meaningful title, and some context from the thread. It might get a page in the docs if I can just figure out what is being requested, and where. Paging @ryantheleach for some assistance...
I'm not good with titles or names :(
The main idea here is to provide documentation for users that does not rely on the assumption that the person reading the docs is a developer, but instead an user wanting to run a Sponge server.
Just because they are are user doesn't mean that they won't run in Text, TextTexmplate and other DataSerializable. Instead they will find these most of the time in their configs. So, the idea goes that if normal users will find these in their configs for example, there should be documentation that they can read up on to find out how to manipulate these.
I might look at this but first I need to fix my workspace, test kashikes annotated commands. fix the config docs, finish the ray tracing docs.
Personally I think the way sponge dumps most ConfigSerializables is insuitable for users to even use.
I don't know if this should be considered a flaw of Sponge, or if plugins should be encouraged to create their own serializers that solve their problems more elegantly, and the choice of plugins will allow users to use what they are comfortable with.
@ryantheleach What needs done with Ray tracing? I thought I included everything
I think the issue should be renamed so as to not be confused with DataSerializables versus ConfigSerializables (or registered through TypeSerializers).
