Skip to content

Docs: 建议完善对「发布插件」章节的文档描述 #3824

@Hypoths

Description

@Hypoths

描述问题或主题

文档前部分的插件开发举例和「发布插件」章节的内容较为脱节,对新手较为不友好。

当前的问题

从当前的文档中,无法得知以下信息:

  • pyproject.toml如何得来,在开发过程中如何进行维护
  • 如何将从nb create plugin得来的插件模板中,得到规范的、用于发布的版本
  • 目前提供的第三方项目模板在README中,都没有详细的描述如何将样例插件套用模板

需做出的修改

可能的建议

  • 推荐以指南中的示例插件——天气插件,为基础,在发布插件的方面更加详细的进行描述
  • 以其中某一个模板为例,描述如何套用插件模板、如何维护pyproject.toml和插件本身,而不仅仅是“保证实际可用性即可”
  • 以某个包管理工具为例,描述如何添加和维护插件的额外依赖

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions