New home for all XenForo documentation

Although we still have a little way to go before our vision is fully complete, the first phase of our documentation overhaul is now live!

Previously our manual and developer documentation were stored in two separate sites, powered by MkDocs, and our REST API endpoint documentation was in a page node, right here on this forum!

1770292289887.webp


Now all of the documentation is in one place, docs.xenforo.com, and you can navigate between the Manual, Developers and API documentation from the top navigation.

It now includes improved search powered by Algolia and features much improved REST API documentation including code samples for many common languages.

For the most part the content remains the same as it was, but in the future we will be reorganising, rewriting and extending our documentation to ensure it becomes a valuable resource for new and old customers alike.

All of our documentation is now fully open source (including the manual) and hosted on GitHub! We appreciate the help so far from contributions, especially kind folks such as @QuackieMackie, towards extending the developer documentation. If you have spotted something missing, outdated, or just in need of any sort of improvement, post an Issue or submit a Pull Request and we'll be excited to get it merged.
 
Click to expand...
Very nice!

I still don't understand why XenForo will not use their own software for knowledge base articles. It seems like a statement that XF is not suitable to host documentation articles and needs to resort to DocuSaurus to patch that. I'd love to see XenForo or a XenForo addon for it. Hopefully this will change in the future.
 
Amazing! I have a few things I can get put up as a PR when I have the free time since I have most of it written up! One of the main reasons I didn't do it right away when making my couple of addons so far is due to the inactivity on the repo.

Also very glad to hear about the upcoming rewrite and extending of the current docs!
 
Alpha1 said:
Very nice!

I still don't understand why XenForo will not use their own software for knowledge base articles. It seems like a statement that XF is not suitable to host documentation articles and needs to resort to DocuSaurus to patch that. I'd love to see XenForo or a XenForo addon for it. Hopefully this will change in the future.
Click to expand...
Oh now that's a good idea
 
Mr Lucky said:
I don't see anything different in the top navigation
Click to expand...
The top navigation of the documentation site now contains three sections, one for Manual, one for Developers and one for API.

These were previously separate pages or documentation sites. They’re now in one place.
 
Alpha1 said:
Very nice!

I still don't understand why XenForo will not use their own software for knowledge base articles. It seems like a statement that XF is not suitable to host documentation articles and needs to resort to DocuSaurus to patch that. I'd love to see XenForo or a XenForo addon for it. Hopefully this will change in the future.
Click to expand...

We have enough to be working on and, sometimes, it makes a lot of sense to use dedicated tools for specific things.

The same reason we haven’t written our own version of GitHub, or Slack or an email client in XenForo. These tools already exist and are very good at what they do and supported and updated without us needing to do anything.

That doesn’t mean XenForo can’t be used to build a docusaurus clone, of course it could. We just don’t want to.
 
A long-term plan for me is to post a series of how-to pages for using forum features, using screenshots to help illustrate the concepts. It still amazes me that even for members who have used XenForo for over a dozen years, they don't know that there are many features and little hidden things that they could be using.

I'm not sure if the format would fit but I wouldn't mind donating the more relevant of those to the cause.
 
Alpha1 said:
Of course @Bob has an amazing Knowledge Base System. It's the best thing since sliced bread.
Click to expand...
I am using the add on and like it but for the XF docs the current approach is lightyears ahead and massively better suited in my eyes, for both, creating and using the documentation. I see not what should be wrong about it and it looks good, too.
 
It wasn't stuck, exactly. It was manually defined... I guess none of us had any inclination to update it in the last 5 years so suffice to say it is now fully automatic.

And now with a new lick of paint :)

1770336107903.webp
 
Back
Top Bottom