mirror of
https://github.com/xingwudao/xquant-beginner.git
synced 2026-07-28 04:37:44 +00:00
docs: add feedback and community entrypoints
This commit is contained in:
@@ -0,0 +1,20 @@
|
||||
name: 正式书建议
|
||||
description: 对正式书结构、附录、案例、章节顺序提出建议。
|
||||
title: "book-v2: "
|
||||
labels:
|
||||
- book-v2
|
||||
body:
|
||||
- type: textarea
|
||||
id: suggestion
|
||||
attributes:
|
||||
label: 建议内容
|
||||
description: 请说明你希望正式书增加、删减或重写什么。
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: reason
|
||||
attributes:
|
||||
label: 为什么这很重要
|
||||
description: 请说明这个建议会帮助哪类读者。
|
||||
validations:
|
||||
required: true
|
||||
@@ -0,0 +1,32 @@
|
||||
name: 概念没看懂
|
||||
description: 反馈某个概念、类比或推导不够清楚。
|
||||
title: "clarity: "
|
||||
labels:
|
||||
- clarity
|
||||
body:
|
||||
- type: input
|
||||
id: chapter
|
||||
attributes:
|
||||
label: 章节
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: section
|
||||
attributes:
|
||||
label: 小节
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: confusing
|
||||
attributes:
|
||||
label: 没看懂的内容
|
||||
description: 请粘贴原文,或描述你卡住的位置。
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expectation
|
||||
attributes:
|
||||
label: 希望补充什么
|
||||
description: 例如:需要生活类比、需要公式解释、需要多一个例子。
|
||||
validations:
|
||||
required: true
|
||||
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 课程与正式书信息
|
||||
url: https://xquant.shop/courses
|
||||
about: 查看 XQuant 课程、正式书和后续更新。
|
||||
- name: 读者群
|
||||
url: https://github.com/xingwudao/xquant-beginner/blob/main/book/feedback.md
|
||||
about: 添加作者微信 xquanter 进入读者群。
|
||||
@@ -0,0 +1,40 @@
|
||||
name: 实验结果不一致
|
||||
description: 反馈运行 spec 或 notebook 后,结果和书中不一致。
|
||||
title: "experiment: "
|
||||
labels:
|
||||
- experiment
|
||||
body:
|
||||
- type: input
|
||||
id: chapter
|
||||
attributes:
|
||||
label: 章节
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: spec
|
||||
attributes:
|
||||
label: Spec 或 notebook
|
||||
description: 例如:q5-how-to-validate/specs/spec-02-annual-breakdown.md
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: 书中结果
|
||||
description: 请写出书中对应的数字、图表或结论。
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: 你的结果
|
||||
description: 请写出你运行出的数字、图表差异或错误信息。
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: 运行环境
|
||||
description: 操作系统、Python 版本、运行日期、使用的 AI 工具。
|
||||
validations:
|
||||
required: true
|
||||
@@ -0,0 +1,34 @@
|
||||
name: 错别字或排版问题
|
||||
description: 报告错别字、标点、链接、图片或排版问题。
|
||||
title: "typo: "
|
||||
labels:
|
||||
- typo
|
||||
body:
|
||||
- type: input
|
||||
id: chapter
|
||||
attributes:
|
||||
label: 章节
|
||||
description: 例如:第 3 章:给 ETF 分钱
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: section
|
||||
attributes:
|
||||
label: 小节
|
||||
description: 例如:3.2 风险平价
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: original
|
||||
attributes:
|
||||
label: 原文片段
|
||||
description: 请粘贴需要修正的原文。
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: suggestion
|
||||
attributes:
|
||||
label: 建议修改
|
||||
description: 请写出你建议改成什么。
|
||||
validations:
|
||||
required: true
|
||||
@@ -0,0 +1,19 @@
|
||||
## 变更内容
|
||||
|
||||
-
|
||||
|
||||
## 影响范围
|
||||
|
||||
- 章节:
|
||||
- 是否影响图片:
|
||||
- 是否影响链接:
|
||||
|
||||
## 验证
|
||||
|
||||
- [ ] 已检查 Markdown 链接
|
||||
- [ ] 已运行 `npm run docs:build`
|
||||
- [ ] 未提交 `docs/`、`node_modules/`、`.vitepress/dist/`
|
||||
|
||||
## 备注
|
||||
|
||||
本书只用于教育和研究,不构成投资建议。
|
||||
Reference in New Issue
Block a user