导读

聆思文档中心(LSOpen)专门提供安徽聆思智能科技有限公司的芯片和方案相关开发资料。

目前主要由聆思产品团队和开发团队进行维护。

项目主要文件

  • docs:当前维护在线上的有效文档,若需改动请参考文档维护指南
    • start:一些基础信息。
    • chips:芯片相关资料,如datasheet、规格书等。
    • tools:开发工具的下载和使用教程。
    • AIsolution:AI应用解决方案。
    • Industrysolution:行业(品类)解决方案。
    • school:线上视频课程,不定期更新。
    • workorder:工单入口。
  • docs_old:已经不维护的文档,过一段时间会删除。
  • static:小文件存放地,如几MB以内的音视频。
  • docusaurus.config.js:一二级目录配置。
  • sidebars.js:侧边栏配置。
  • src:可配置pages文件夹下mock.json自定义首页,其他文档贡献者和维护者无需关心。

文档上线流程

出于文档贡献开放的考虑,这里只将对象分为阅读者和维护者。

文档维护大致分为两步:

  1. 阅读者对文档提出建议或者纠错(请参考文档意见反馈),或者维护者需要更新文档。
  2. 维护者确认文档更新需求和内容,对文档进行维护,完成后上线对外发布(请参考文档维护指南)。

文档维护规范

  1. 标题
  2. 文本
  3. 段落
  4. 数值
  5. 标点符号
  6. 文档体系
  7. 参考链接

注:该处参考引用了开源中文技术文档的写作规范

文档撰写默认也必须使用Markdown标准语法来完成。

此外,聆思文档中心使用 Docusaurus 框架,故编辑文档过程中可以使用 Docusaurus 本身支持的一些特性,来优化文档的阅读体验,以下是一些特性使用示例,供你参考:

查看规范的文档展示页面:符合规范的文档样式

文档意见反馈

文档中心的每篇文档下,都可以填写你的反馈,反馈内容提交后将会自动创建一条issue,指派聆思工作人员。

你也可以在仓库直接提交issue,issue请指派聆思工作人员账号zainosl

文档反馈后,聆思工作人员将会审核你的反馈,并在issue中做回复。

image

文档维护指南

快速维护

针对现有文档进行快速更改和修复,适合少量内容修改和补充。

  1. 在源文件md页面中,单击“编辑“按钮,在对应内容处完成更改、修复。
  2. 修改完成后,可单击“预览“按钮,确认修改结果。
  3. 确认无误后,在“Commit changes“中填写修改意见和补充信息,提交。

image image

详细维护

针对较大范围的文档内容新增、优化、修复。

参考文档维护详细教程(内部可看)

FAQ

克隆、推送失败,建议重启终端/客户端、试多几次,重启可以解决90%的问题。

或者,联系 @刘钟蔚 or @赵卓斌 检查账号权限。

若非重启和权限问题,可根据不同的报错,找到对应的解决方案:

  • 错误:LibreSSL SSL_connect: SSL_ERROR_SYSCALL in connection to github.com:443
  • 错误:remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.

依旧有问题,可联系@刘钟蔚

使用小技巧

贡献

欢迎开发者参与文档的贡献,不限于实现业务时遇到各种各样的问题,对应的解决方案和FAQ,以及创新参考。

有贡献需求,可通过issue指派zainosl或者邮箱zwliu@listenai.com联系聆思工作人员。

ReleaseNote

每个版本以及迁移说明都记录在GitHub的ReleaseNote页面上。