A well-organized and accessible documentation site is a cornerstone of user experience. It’s not just about presenting information but also about navigation and ease of access. Among the essential elements, the header stands out as a prime spot to include crucial links and menus for swift navigation. If you’re using the ReadTheDocs theme and seeking … Read more
A well-structured documentation homepage serves as the gateway to your product documentation. So, it must be easy to navigate and enable discoverability of your content. In this blog post, I provide a template that you can customize to create a documentation page. This template relies heavily on the elements from the sphinx-design extension, specifically cards, … Read more
In this guide, I will walk you through the process of integrating Typesense with the Read the docs theme for your documentation website. This integration allows you to add a powerful search feature to your documentation, making it easier for users to find the information they need. Summary: Before we begin, let’s outline the infrastructure … Read more
In this post, I explain how you can write a GitHub action that will generate HTML from Restructured Text (reST) and upload the HTML files to an S3 bucket. This workflow ensures that when you merge any changes to your reST source, the HTML is automatically built and posted to your hosting provider. Introduction Creating … Read more