We’ve been hard at work updating our documentation to be clearer, easier to understand and fundamentally, updated to be for the latest version of Atria. As outlined in our 2024 review, we have a fantastic new documentation site – docs.getatria.com.
From general layout changes; to fully re-written installation, upgrade and troubleshooting docs.
We’d love any feedback you have – but we believe this is a fantastic change and much clearer to support you.
Why the Change?
We’ve had our existing documentation site for awhile now which is natively integrated in with our Support Desk Software – Fundamentally, we identified various issues with it.
- Difficult if not impossible to find what you are looking for with the search
- Our layout wasn’t the best to help you effectively find the documentation you were looking for
- From a actual Atria support staff perspective – It was very difficult to maintain and update existing documentation. The formatting was non-standard and wasn’t user friendly.
We wanted to update the documentation, leave the legacy documentation in the past, and move forward. We were planning to re-write and update most of the documentation, doing this process with our existing tool would take much longer than moving to something modern, so we decided to look to the market, and found Docusaurus.
What is Docusaurus?
Docusaurus is an open-source static site generator designed to help you build optimized websites quickly, focusing on your content. Developed by Meta Platforms, Inc., it allows you to create documentation websites, blogs, marketing pages, and more with ease. By leveraging the full power of React, Docusaurus enables seamless customization and extension of your site’s layout and functionality. For more information – See their website – https://docusaurus.io/
What are the benefits of Docusaurus?
1. Lightning-Fast Performance
Docusaurus is a static-site generator that builds single-page applications with swift client-side navigation. This means that our documentation pages load faster, providing you with immediate access to the information you need. No more waiting around—just quick, reliable content at your fingertips.
2. Powerful Search with Algolia
We understand the frustration of sifting through pages to find specific answers. That’s why we’ve integrated Algolia Search into our platform. This powerful tool offers accurate and high-performance search capabilities, allowing you to locate relevant information in seconds. This has much more contextual understanding, and is unbelievably fast at finding content that you may be looking for. This also reports back to us to let us know when a search has found no results at all, so we can see where the documentation needs to be improved to have better content for you and your searches.
3. Intuitive Content Organization
Navigating through documentation should be straightforward. We’ve restructured our content into clear categories, making it easier for you to find what you’re looking for. For example, our Troubleshooting Index dynamically compiles articles based on tags, offering a centralized hub for all troubleshooting resources.
4. Updated and Clear Content
Content clarity is crucial. We’ve taken the time to review and update all our existing documentation. Each article has been rewritten to ensure accuracy and ease of understanding, so you can confidently rely on the information provided. This has then been tested and implemented by our team before being added to the documentation to be sure its up to date.
Behind the Scenes: Our Custom Indexes
To enhance your experience further, our development team crafted a custom indexing function within Docusaurus. This feature dynamically generates a ‘Knowledgebase Index Page’ by aggregating articles based on their assigned tags. The result? A cohesive and efficient way for you to access related content tailored to your needs. This feature custom built by our developers – Which we will hopefully share with the world when it is a bit more refined!
Seamless Updates with Vercel
Keeping our documentation current is essential. We’ve partnered with Vercel to integrate our platform with our existing development pipelines. This collaboration enables continuous deployment, allowing us to apply updates effortlessly and ensure that you always have access to the latest information. This also means that it is distributed globally, so will be snappy and quick for all of our global customer base.
Why did we choose Docusaurus?
For those considering a similar upgrade, Docusaurus offers a range of benefits:
•Ease of Use: Content is written in Markdown, making it accessible even to those without extensive technical backgrounds. We’ve adopted using tools such as FrontMatter to enable quick development of documents for the people in our team without extensive Markdown knowledge.
•Customization: Built on React, Docusaurus allows us to customize the site to meet our brand and functional requirements. The ability to create custom JS components to create features that meet our specific requirements has been incredibly easily.
•User Experience: It looks fantastic, it’s quick and responsible, and it has an amazing search!
We value your feedback and invite you to explore the new platform. Your insights are crucial as we continue to refine our resources to better serve you.
Visit docs.getatria.com and experience the improved documentation firsthand.
