This repository is the documentation and website source for KubeVela, a platform built with Docusaurus 2 static site generator.
The repository serves as the central hub for KubeVela's documentation and web presence. It contains English-language documentation files organized in a structured format, along with supporting resources like images and navigation configuration. The documentation is written in Markdown and follows specific formatting conventions, including frontmatter requirements and relative path linking. The project uses Docusaurus 2 to transform these source files into a published website, with automated validation through GitHub Actions to ensure documentation builds successfully before changes are merged.
Contributors should understand that this repository handles documentation maintenance and localization coordination. The primary workflow involves editing Markdown files in the docs/en directory, managing images in docs/en/resource, and updating the sidebars.js navigation file. Changes trigger automated checks that validate the documentation can build correctly. The repository also manages versioning of documentation alongside code releases, with new feature documentation added to the latest docs before version snapshots are created. A Chinese localization workflow is supported through a separate README. Local preview capability is available through Yarn-based development and build commands.
The project maintains active contribution workflows with pull request requirements including DCO sign-off. The development process emphasizes validation and consistency, with structured guidelines for documentation formatting and contribution procedures.
