Home / Companies / Mintlify / Blog / November 2023

November 2023 Summaries

6 posts from Mintlify

Filter
Month: Year:
Post Summaries Back to Blog
In November 2023, Mintlify shipped new upgrades to its API Playground, Web Editor, and Landing Page. The company revamped its landing page to reflect its expanding team, recent feature releases, and growing customer base of over 1000 companies. Major improvements were also made to the API Playground, including support for MDX syntax, `readOnly` and `writeOnly` fields, and a Paramfields redesign. Additionally, the web editor was updated with new features allowing users to add, delete, and rename files and folders directly from the dashboard. These updates are now available and can be viewed by running a specific npm command.
Nov 30, 2023 241 words in the original blog post.
November 2023 marked significant product updates for Mintlify, including a complete redesign of the landing page, reflecting its growth to over 1,000 companies. The API Playground saw major improvements, such as a redesigned Paramfields and support for MDX syntax, along with `readOnly` and `writeOnly` fields, which are automatically applied to users' playgrounds. The Web Editor was also enhanced to allow users to add, delete, and rename files and folders directly from the dashboard, streamlining the documentation editing workflow. These updates demonstrate Mintlify's commitment to improving user experience and accommodating its expanding user base.
Nov 30, 2023 387 words in the original blog post.
Mintlify's design philosophy prioritizes principles over process, emphasizing speed and agility. The company adopts a simple, free-form, and lean design process that encourages close collaboration between designers and developers. Great design should feel natural and seamless, guiding the user through its components without explicitly drawing attention to its design. This approach is reflected in Mintlify's documentation, which is designed to be intuitive and non-obstructive for users. The company aims to make its users proud of their documentation, offering a balance between making reasonable assumptions and giving users the freedom to customize their documentation. By listening to user feedback and iterating on their designs, Mintlify strives to create magical moments in their products.
Nov 14, 2023 1,337 words in the original blog post.
Mintlify's design philosophy is built on three core principles: creating "invisible" design that feels intuitive and seamless, recognizing developers as users who deserve exceptional experiences, and maintaining an opinionated yet flexible approach. The team emphasizes rapid iteration, close collaboration between designers and developers, and a commitment to detail, ensuring that their documentation provides a user experience that developers can appreciate. Good design, according to Mintlify, is about cultivating taste through experience and practice, and achieving design that feels inherently right. This is achieved by balancing speed and agility with thoughtful iteration and flexibility, allowing users to choose their level of customization. Mintlify aims to empower developers by providing tools that create aesthetically pleasing documentation, emphasizing that developers care about design quality. The company's approach prioritizes user feedback and iterative development to continuously improve their product and capture the elusive "magical moment" where design and functionality align perfectly.
Nov 14, 2023 1,495 words in the original blog post.
Stripe creates the best documentation in the industry by fostering a strong writing culture that encourages employees to write high-quality documentation. The company has embedded writing into its culture, with a press that publishes books and an engineering magazine, and leaders who set the tone for thoughtfulness and attention to detail. Stripe also created support systems, such as resources and guides for developers on how to write good docs, classes on writing and documentation best practices, and office hours where employees can seek advice from technical writers and documentation experts. The company includes documentation expectations in engineers' job ladders and rewards people for creating high-quality documentation. Finally, Stripe builds documentation that feels like a product, with interactive features and a custom syntax called Markdoc.
Nov 10, 2023 1,329 words in the original blog post.
Stripe has established itself as a leader in developer documentation by fostering a culture that prioritizes high-quality writing, a commitment reflected in their comprehensive, user-friendly, and aesthetically pleasing docs. This culture is driven by leadership example, with initiatives such as embedding documentation in career ladders and performance reviews, and creating support systems for developers, including writing guides and classes. Stripe's documentation is designed to feel like a product, featuring interactive and customizable elements, such as code examples tailored to users' needs, supported by their custom Markdoc syntax for enhanced flexibility and manageability. Despite its significant size and resources, Stripe's approach to documentation has been a priority since its inception, demonstrating that any company can achieve similar success by investing in a writing-focused culture and supportive infrastructure.
Nov 10, 2023 1,497 words in the original blog post.