August 2022 Summaries

The text discusses the option of hiding the download button for the OpenAPI definition in Redocly's API documentation. Redocly provides a feature to hide this button, which some users may want to utilize to alter the appearance or location of the link, despite the fact that hiding it does not protect the API definition from being accessed through other means, such as inspecting network traffic. The decision to hide the button should be carefully considered, as it may inconvenience API consumers who use the OpenAPI format for code generation or validation. Redocly has supported hiding the download button for over four years, but its practical use case remains limited primarily to aesthetic changes. The configuration to hide the button can be applied through various methods, including the Redocly configuration file, Redocly portal legacy page format, and Redocly HTML element, each requiring specific syntax to toggle the feature.

Redocly offers a suite of tools that assist companies in creating comprehensive and updated API documentation, enhancing the overall developer experience through robust integration with OpenAPI definitions. Technical writers play a crucial role by collaborating with developers and product teams to generate detailed API references, user guides, and technical documentation. Redocly's platform is tightly integrated with Git for source control, allowing for seamless tracking and management of documentation changes. The platform includes features like an API registry for managing definitions, a portal for extending content, a VS Code extension for maintaining OpenAPI documents, and a docs-as-code approach for streamlined collaboration and validation. Redocly facilitates the entire documentation lifecycle from creation to publication, offering tools for automated linting, content customization, interactive elements, and analytics integration, ensuring that technical writers can efficiently produce and manage high-quality API documentation and developer portals.

Redocly has been actively developing new features and enhancements across its products, despite a brief hiatus from blogging due to a team member's vacation. Recent updates from May to July 2022 include several improvements and new capabilities like file editing in the API registry, an API style guide for consistency, and more customizable "try it" controls. The developer portal is in maintenance mode while a new portal, offering better performance and features, is under development and expected for internal use by September. The OpenAPI CLI has been renamed to Redocly CLI, with expanded built-in rules and improved documentation, making it the most downloaded OpenAPI-related style guide tool on npm. Redoc 2.0 is also in the works, with significant changes anticipated before the next blog update. Redocly is currently seeking a Technical Writer and Developer Advocate to contribute to their documentation and product development efforts.