Skip to content

目前项目状况和运行指南 - Current Project Status and Build Guide #2

@Ikutsu

Description

@Ikutsu

中文

项目状况

  • 项目通过GitHub Action定时触发获取文档并进行翻译和处理成框架能够解析的语法和格式,让后Cloudflare检测到更新并运行框架构建
  • 目前已支持的文档框架:Docusaurus,Writerside(不完全)
  • 目前已翻译的文档:Koin,Kotlin
  • 需要支持的文档框架:Mkdocs
  • 后续计划翻译的文档:Ktor,SQLDelight,Gradle

运行指南

Koin

Koin的脚本完全自动化并不需要调整。

Kotlin

Kotlin目前靠手动更新,原因是转换脚本不稳定,会出现转换后构建报错的情况。建议在额外的branch上测试并修复再push到main。

English

Project Status

  • The project uses GitHub Actions to periodically trigger document retrieval, translation, and processing into syntax and formats that the framework can parse, then Cloudflare detects updates and runs the framework build
  • Currently supported document frameworks: Docusaurus, Writerside (partially)
  • Currently translated documents: Koin, Kotlin
  • Document frameworks to be supported: Mkdocs
  • Documents planned for future translation: Ktor, SQLDelight, Gradle

Operation Guide

Koin

Koin scripts are fully automated and do not require adjustments.

Kotlin

Kotlin is currently updated manually because the conversion scripts are unstable and may cause build errors after conversion. It is recommended to test and fix on an additional branch before pushing to main

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions