→ Back to Home
Backstage

Backstage v1.57.0-next.1 Introduces Zensical Engine for TechDocs, Addressing Material for MkDocs Sunset

Backstage has released v1.57.0-next.1, an important update that integrates the experimental Zensical engine for TechDocs. This release specifically targets the upcoming discontinuation of Material for MkDocs, offering a new path for documentation generation within Backstage. Key components of this update include the new `@backstage/plugin-techdocs-backend-module-zensical` module, Zensical support within `@techdocs/cli`, and new alpha building blocks in `@backstage/plugin-techdocs-node`. This development is significant for any organization heavily invested in Backstage's TechDocs for their internal documentation. With Material for MkDocs ceasing operations, the introduction of Zensical provides a timely and necessary alternative. Platform teams and documentation owners are directly affected, as they will need to evaluate and plan for this migration to ensure their developer portals remain functional and their documentation accessible. The move underscores Backstage's commitment to providing a stable and evolving platform, even as external dependencies shift. This update fits into the broader trend of maintaining developer experience platforms with robust, adaptable tooling. As developer portals like Backstage become central to internal developer platforms, the underlying components must be resilient to changes in the open-source ecosystem. The proactive integration of Zensical demonstrates an understanding of the operational challenges faced by large organizations that depend on these tools. It also highlights the continuous effort to enhance and modernize the documentation experience within Backstage, which is a core pillar of any effective developer portal. In practice, practitioners should begin assessing their current TechDocs setup and the extent of their reliance on Material for MkDocs. While Zensical is currently experimental, its inclusion in a `next` release signals its readiness for broader testing and eventual adoption. Teams should start exploring the new modules and command-line support, perhaps by setting up parallel environments to test the Zensical engine with their existing documentation. This proactive approach will allow for a smoother transition, identify potential issues early, and ensure that documentation remains a seamless part of the developer workflow as the deprecation of Material for MkDocs approaches.
#backstage#techdocs#zensical#documentation#developer portal#migration
Read original source