MaaAssistantArknights / MaaAssistantArknights/maa-cli
自动生成 JSON Schema 和文档
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 117
- Forks
- 39
- PR merge metrics
- No merged PRs in 30d
Description
当前 JSON Schematic [schema files](./crates/maa-cli/schemas) 和命令相关的文档是手动编写的，这非常的琐碎无聊且容易遗漏。有一些 crate 可以帮助自动生成，以此来避免手动编写：
- [schemars](https://docs.rs/schemars/latest/schemars/): 生成 JSON Scheme；
- [clap-markdown](https://github.com/ConnorGray/clap-markdown): 生成命令文档，这可能需要配合本地化，来生成不同语言的文档。
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the existing JSON Schema files under crates/maa-cli/schemas and the manually maintained command documentation. Evaluate how schemars and clap-markdown could generate these outputs, including localized command documentation. Done means the schemas and command docs are generated from the CLI definitions instead of being maintained manually.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100