June 2024 Summaries

OpenAPI automations have been added to the documentation, allowing for seamless autogeneration of API Reference docs and removing manual labor required to reflect changes in production. The new functionality can be achieved by adding an openapi field to objects in tabs or anchors arrays in the mint.json file, or by using OpenAPI Specs hosted at a URL. The feature is now available for developers to try out, and instructions on how to update their CLI and add the code to their mint.json file are provided.

Launch Week III Day 5 announced the introduction of OpenAPI automations, allowing for the seamless autogeneration of API Reference documentation from OpenAPI specifications, which eliminates the need for manual updates when APIs change. Users can enhance their API Playground pages by adding an 'openapi' field to the mint.json file, enabling automatic updates for both local files and hosted URLs. This feature ensures that API documentation is always current, reflecting changes promptly and efficiently. To implement this, users need to update their CLI and modify the mint.json file accordingly. The announcement encourages users to stay informed about new features by following updates on social media and joining the community.

User Auth` allows you to tailor documentation content to specific users based on their identifiers, enabling more relevant and contextualized information. This can streamline the onboarding process for new developers by providing them with personalized guides and features. To implement `User Auth`, users must be authenticated using one of two methods: shared session or JWT, and then access the `userContext` variable to retrieve user-specific information. The feature is currently available only for select enterprise organizations, and its implementation can help improve the overall developer experience.

Launch Week III Day 4 announced the introduction of User Authentication for documentation, enabling teams to identify users and customize content based on their identity, plan, or organization. This enterprise feature allows for personalized experiences such as pre-filled API keys, enterprise-specific endpoints, and tailored guides, which streamline onboarding and provide contextual documentation for different user segments. By authenticating users via shared sessions or JWT, developers can access more relevant and contextualized information, making it easier to find and understand necessary details. This feature, aimed at enterprise organizations, enhances the onboarding process by allowing new developers to quickly familiarize themselves with products. Contact with the sales team is encouraged for demos, and updates on further developments are available through social media and community engagement.

Search V2 has been launched by Mintlify, bringing improved performance and a modern user experience for product discovery. The new search functionality is now available to all users, with features such as an upgraded UI, indexing of OpenAPI endpoints, and support for components. These enhancements aim to reduce frustration and increase efficiency in finding relevant information, ultimately leading to a better user experience.

Launch Week III Day 2 introduced Search V2 for Mintlify users, highlighting significant performance enhancements and an improved user experience for product discovery. The update features a modernized user interface, indexing of OpenAPI endpoints for direct API queries, filtering of hidden pages, and enhanced searchability of component attributes, all aimed at making it easier for users to access relevant documentation and API references swiftly. These improvements address user feedback, aiming to reduce frustration and support tickets by enabling efficient navigation of documentation. The upgraded search capabilities are available to all Mintlify users, with options for new users to explore these features.

The web editor has been successfully launched and has allowed non-technical users to leverage Mintlify across various functions. To further improve user experience, branch and PR functionality have been added, enabling users to create separate versions of their documentation without affecting the main project. This feature allows for collaborative work between developers and non-technical team members, streamlining the process of proposing changes and merging them into the main project. The new functionality is now available for all users and can be accessed through the dashboard.

Launch Week III Day 3 introduced branch and pull request functionality to Mintlify's Web Editor, enabling seamless collaboration between non-technical team members and developers on documentation changes. This update allows users to create branches to work on separate versions of documentation without affecting the main project, save progress, and propose changes through pull requests for team review and approval. Integrating GitHub workflows into the dashboard, this feature empowers non-technical users to leverage the web editor across various functions, enhancing collaborative efforts in marketing, operations, and customer success. The branching and pull request capabilities are now available to all users, marking a significant step in Mintlify's commitment to facilitating efficient and inclusive documentation processes.

Mintlify launches themes as part of its third Launch Week, offering three pre-configured themes: Quill, Prism, and Venus, with more to come. Themes enable users to transform the styling and layout of their documentation to fit their branding, allowing for a unique look that stands out from others.` `Mintlify's themes are customizable through a simple mint.json configuration file, which can be enabled by adding a single line of code with specific values such as "quill", "prism", or "venus".` `The themes are designed to cater to different brand styles and use cases, including minimalist, gradient, and utility designs.` `Users can get started with Mintlify's documentation tools by signing up for a free account on the dashboard and trying out the new features during Launch Week.

Mintlify's Launch Week III Day 1 introduced a new feature that allows users to customize their documentation's styling and layout with themes, responding to a popular request from users. Three initial themes were launched: Quill, which offers a minimalist design; Prism, which adds vibrant gradients; and Venus, tailored for API and SDK-heavy products with a focus on usability. These themes can be easily applied using a single line of code in the `mint.json` file, with further customization options available. This launch marks the beginning of a week-long event where Mintlify will release new features daily.