openyurtio/openyurt.io

OpenYurt.io is a documentation website built with Docusaurus that serves as the central resource for the OpenYurt project.

The repository contains the source code for the OpenYurt website, which provides user documentation for the OpenYurt platform. The site is built using Docusaurus, a static site generator that enables the creation of modern documentation websites. The documentation is organized to support multiple versions of OpenYurt, with each release version maintaining its own corresponding documentation set. The site supports both English and Chinese languages, requiring parallel documentation maintenance across both language versions.

Contributors adding or updating documentation need to understand the version-specific structure. For historic versions like v1.0, English documentation goes in versioned_docs directories while Chinese translations are placed in corresponding i18n paths. Documentation for unreleased next versions follows a different structure using docs and i18n/zh/docusaurus-plugin-content-docs/current directories. Sidebar configuration files must be updated when the documentation structure changes, and Chinese sidebar translations must be kept in sync with English versions. The project also supports blog content with separate directories for English and Chinese posts, along with author metadata management. Local builds can be performed before submitting contributions to verify the website renders correctly.

The project maintains active documentation workflows with clear contribution guidelines for handling versioned content, bilingual support, and structural organization. Development activity shows ongoing attention to keeping documentation synchronized across multiple versions and languages, with established processes for local testing before contributions are merged.