🧾 Exciting Update to Our Developer Documentation! #46
dominique-boerner
started this conversation in
General
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
We're thrilled to announce a significant update to our developer documentation that will enhance your coding experience!
What's Changed?
Previously, our developer documentation was consolidated into a single, sprawling AsciiDoc file. While comprehensive, this format proved to be overwhelming and daunting, especially for newcomers trying to find their way around our codebase.
Enter Antora!
We've now transitioned to using Antora for generating our developer documentation. This brings a slew of benefits, making your development journey smoother and more efficient:
Modular Documentation: Antora allows us to break down the documentation into manageable, topic-based modules. This means quicker access to the information you need.
Improved Navigation: With a structured, multi-page format, navigating through documentation is now intuitive. Find what you need without wading through irrelevant content.
Enhanced Readability: A clean, modern layout with Antora not only makes reading easier but also makes the process of finding and understanding information more straightforward.
Collaborative Contributions: The Antora framework makes it simpler for team members to contribute to the documentation, ensuring it stays up-to-date and comprehensive.
Getting Started
To dive into our new and improved documentation, visit our Foxdeck Documentation.
We believe these changes will make a big difference in your day-to-day development work. As always, we're eager to hear your feedback and make further improvements.
Happy coding!
Best,
Dominique Börner
Maintainer
Beta Was this translation helpful? Give feedback.
All reactions