I'm fairly new to XenForo development, and while working through the documentation, I ran into something that might be obvious to veterans but was confusing for me: it's not clear what version of XenForo the documentation is targeting.
For example, when reading the Add-on structure page, there's no indication whether the information is specific to 2.x.x, or if any of it is deprecated or outdated for newer versions.
To help with that, I put together a very basic system for version control and annotations. You can see what I was going for here:
https://github.com/QuackieMackie/XenforoDevDocs
I’m also new to MkDocs so I’m sure this could be improved, but you get a rough idea. I think this would be very helpful, especially for beginners trying to understand what's still valid and current. The community has lots of experienced developers, but more beginner-friendly clarity would really help bridge that gap.
Granted this would be a large change to how the documentation is currently, but I do think this is something that eventually needs to be put into place. Updating the latest information is only good if it's kept up to date.
I'm fairly new to XenForo development, and while working through the documentation, I ran into something that might be obvious to veterans but was confusing for me: it's not clear what version of XenForo the documentation is targeting.
For example, when reading the
Add-on structurepage, there's no indication whether the information is specific to 2.x.x, or if any of it is deprecated or outdated for newer versions.To help with that, I put together a very basic system for version control and annotations. You can see what I was going for here:
https://github.com/QuackieMackie/XenforoDevDocs
I’m also new to MkDocs so I’m sure this could be improved, but you get a rough idea. I think this would be very helpful, especially for beginners trying to understand what's still valid and current. The community has lots of experienced developers, but more beginner-friendly clarity would really help bridge that gap.
Granted this would be a large change to how the documentation is currently, but I do think this is something that eventually needs to be put into place. Updating the latest information is only good if it's kept up to date.