koishijs / koishijs/docs

希望增加一些关于插件Config的详细信息和best practice

Open
#41 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Vue
Stars
27
Forks
142
PR merge metrics
No merged PRs in 30d

Description

文档中介绍了插件应当export一个Config interface,然后用schemastery对config进行验证,但是没有提到每个插件的config具体如何对应到koishi.yml的某个值,同时希望增加一下常见的嵌套插件的情况下的config的best practice

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the plugin Config documentation and the koishi.yml configuration examples. Explain how each plugin's Config maps to a koishi.yml value, then document best practices for nested plugins and validate the examples against the existing schemastery guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.