XF 2.3 Versioned Documentation

[QuackieMackie]

Howdy Xenforo People,

I've been referring to the developer docs https://xenforo.com/docs/dev/ quite often, and it's clear, it's a tad outdated.

I was wondering, is there a specific reason the docs haven't been versioned yet? It would be really helpful to know which version of XenForo a given page applies to, especially when APIs or behaviors change between releases.

Would anyone object to setting up versioning?

A few things I noticed so far:

• The windows development enviroment for example, https://laragon.org. The lite version isn't even available anymore.
• Let's build addon, the provided zip folder when downloaded gives this error:

PHP Fatal error:  Declaration of Demo\Portal\XF\Entity\Thread::canFeatureUnfeature() must be compatible with XF\Entity\Thread::canFeatureUnfeature(&$error = null): bool in C:\inetpub\wwwroot\xenforo\src\addons\Demo\Portal\XF\Entity\Thread.php on line 7

 

[QuackieMackie]

Update: https://github.com/xenforo-ltd/docs/issues/62 I created an issue on github.
And drafted up a brief demonstration of what it could look like. https://github.com/QuackieMackie/XenforoDevDocs

 

[Chris D]

Thanks for pointing that out.

To be honest if the issues are so few, we’d probably just fix them, and not be too concerned with versioning. We tend not to recommend or support older versions anyway.

 

[QuackieMackie]

Thanks for pointing that out.

To be honest if the issues are so few, we’d probably just fix them, and not be too concerned with versioning. We tend not to recommend or support older versions anyway.

Ah I see, I was under the assumption that older versions were still supported.

 

[Chris D]

Not especially.

That being said, eventually there may be a use for this in the near future so it will become a necessity and we thank you for your efforts in putting this together.

In the meantime if you wanted to create specific issues or PRs for the issues you found, that would be hugely useful.

Probably don’t worry too much about dev environment stuff right now as I have some thoughts on that.

 

[QuackieMackie]

In the meantime if you wanted to create specific issues or PRs for the issues you found, that would be hugely useful.

I'll start adding the ones I noticed.

Probably don’t worry too much about dev environment stuff right now as I have some thoughts on that.

I quite like inetpub for windows, it's what I was most familiar with and it wasn't to difficult to set up. It just means it's on when my pc is on.

As a side note, i'd quite like a section in the documentation that would explain small concepts with examples.
I find it a lot easier to digest small snippets rather than the huge example thats provided. But thats a preference thing.