Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to support an overall introduction page for the documentation? #291

Open
tianmingxing opened this issue Jun 14, 2022 · 1 comment
Assignees
Labels
enhancement New feature or request running running

Comments

@tianmingxing
Copy link
Contributor

tianmingxing commented Jun 14, 2022

Summary(关于这个pr的描述)

Besides detailed explanations of the interfaces, weBesides detailed explanations of the interfaces, we related instructions, such as the such as the domain name for requesting interfaces, points to note when calling them, handling of some common issues, etc. All these need a page for clarification.

除了接口详细说明外,还需要记录一些相关的说明,例如:请求接口的域名,调用的注意事项,一些常见问题的处理等等。这些都需要有一个页面来进行说明。

Basic example(pr的用例)

1)It would be great if we could specify the relative path of this custom page in the configuration file, and the documentation can be in markdown format(可以在配置文件中指定这个自定义页面的相对路径,文档可以是markdown格式)
2)When generating, these pages should be rendered into the main documentation(在生成时将这些页面渲染到主文档中。)

Motivation(提出这个pr目的)

Some common information related to the interfaces needs to be documented.
需要记录一些和接口有关的公共信息

@tianmingxing tianmingxing added the enhancement New feature or request label Jun 14, 2022
@luniard
Copy link

luniard commented Jul 15, 2022

I strongly suggest updating this.
强烈建议更新下这个

@chenqi146 chenqi146 self-assigned this Oct 10, 2022
@chenqi146 chenqi146 added the running running label Dec 15, 2023
@shalousun shalousun changed the title 支持文档整体介绍页面 Is it possible to support an overall introduction page for the documentation? Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request running running
Projects
None yet
Development

No branches or pull requests

3 participants