XF 2.2 Contribute to our XF2 Developer Documentation

Chris D

XenForo developer
Staff member
Licensed customer
WIthin our community there is an absolute wealth of knowledge and experience in terms of developing for XenForo and we already help each other out a great deal by responding to questions posted by our fellow developers in this very forum.

But, sometimes, we can share that knowledge and experience in other ways, and one way to do that would be to turn our XF2 Developer Documentation into a crowd-maintained resource so that we can all help each other and indeed aspiring XenForo developers to hit the ground running when starting development projects for XenForo.

For the most part, we previously were not accepting community-submitted changes to our GitHub documentary repo, but that is what we are changing today.

If you are interested in submitting new content to our documentation, or even if you've just spotted a pesky typo that you'd like to fix, feel free to familiarise yourself with our Contribution guidelines and submit those changes to us directly.

The page above gives a brief overview of how to set up and use MkDocs (which is optional) and further how to submit changes and gives some very short guidance for contributions submitted in this way.

For anyone considering submitting changes to our documentation, no matter how small, thank you :)
 
I spent my day and last night writing documentation, I don't know if github gets checked often so I thought i'd mention it here:

If anyone would be able to give it a look over it as a second set of eyes that would be great.
 
Added a few more changes to this PR:
If anyones able to review those changes that would be great :)

Also I went with a bit of a different styling, compared to the rest of the template-syntax.md formatting.
I do plan on modifying the rest of the file structure to look similar, it's just a huge amount of work so I haven't gotten to it yet.


This has now been formatted, to be a bit easier to navigate. I hope :)
 
Last edited:
New PR's if anyone can check them out. :)
 
Just wanted to say we're all very appreciative of the work you're doing on the documentation. I promise your work will be published soon! We're just trying to get a few other development tasks out of the way.
 
Just wanted to say we're all very appreciative of the work you're doing on the documentation. I promise your work will be published soon! We're just trying to get a few other development tasks out of the way.
Thank you for letting us know. :)
I appreciate the response.

I have a few bits I still want to fix/update, such as:
1. The broken add-on https://github.com/xenforo-ltd/docs/issues/63
2. Still missing a lot of syntax https://github.com/xenforo-ltd/docs/pull/66

Is there anything else you can think of that would be handy to document?
 
In case you weren't aware, these PRs have been updated to the new docs format. If there's any problem with how this has been done let me know. It was my first time fixing a conflict of this size, so I learnt as I worked through them.
 
Back
Top Bottom