Skip to content

OG-star-tech/OG-star-tech-wiki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OG Star Wiki 贡献指南

欢迎参与 OG Star 官方 Wiki 的建设与完善。

本 Wiki 使用 Wiki.js 构建,并与 GitHub 仓库自动同步。
所有文档均以 Markdown 格式管理,任何改动都会进入版本历史。

在线文档入口:
https://wiki.ogstartech.cn/zh/home


如何参与贡献

我们欢迎任何形式的改进,包括:

  • 修正文档错误
  • 补充缺失内容
  • 优化说明表达
  • 添加教程或经验
  • 提供技术资料
  • 上传截图或示意图

不需要是开发者,只要有经验可以分享,就非常欢迎参与。


贡献方式

你可以根据自己的熟悉程度选择以下方式。

方式一:直接在 Wiki 编辑(仅限内部)

适用于:

  • 修改错别字
  • 补充说明
  • 添加截图
  • 小范围更新

步骤:

  1. 打开需要修改的 Wiki 页面
  2. 登录账号
  3. 点击右上角「编辑 (Edit)」
  4. 修改内容
  5. 填写修改说明
  6. 保存提交

系统会自动同步到 GitHub,无需额外操作。


方式二:通过 GitHub 提交(适合所有人)

适用于:

  • 新增完整文档
  • 大规模修改
  • 技术性内容更新

步骤:

  1. Fork 本仓库
  2. 修改对应 Markdown 文件
  3. 提交 Pull Request (PR)
  4. 等待维护者审核合并

所有文档均存储为:

Markdown (.md)


文档编写规范

为了保持文档一致,请遵循以下基本规则。

标题结构

请使用清晰的标题层级:

一级标题

二级标题

三级标题

避免跳级使用标题。


内容格式

建议:

  • 每段文字保持简洁
  • 多使用列表
  • 分步骤描述操作
  • 关键内容适当加粗

示例:

安装步骤

  1. 连接设备
  2. 打开电源
  3. 启动软件

图片规范

建议:

  • 使用清晰截图
  • 裁剪无关区域
  • 标注关键位置
  • 控制图片大小

避免:

  • 模糊截图
  • 未裁剪的大图
  • 重复图片

推荐贡献内容

如果你不知道从哪里开始,可以尝试:

  • 补充缺失截图
  • 增加使用案例
  • 编写新手指南
  • 整理 FAQ
  • 添加故障排查步骤
  • 分享使用经验
  • 编写 DIY 或改装记录

这些内容对社区非常有价值。


提交说明建议

每次保存或提交时,请填写清晰说明,例如:

修正拼写错误
补充对极轴步骤
新增Zenit安装说明
优化图片说明

避免:

update
fix
修改

(过于模糊)


内容注意事项

请确保:

  • 内容真实可靠
  • 不侵犯版权
  • 不包含商业广告
  • 不发布未经验证的危险操作

如涉及:

  • 电气改造
  • 固件烧录
  • 硬件修改

请注明风险提示,例如:

本操作具有一定风险,请自行评估并承担责任。


审核流程

所有修改都会进入版本管理:

编辑 → 提交 → 审核 → 发布

维护者可能会:

  • 调整格式
  • 修正细节
  • 合并重复内容

这是正常流程。


版权与许可

除非特别说明,本 Wiki 内容采用:

CC BY-NC-SA 4.0

即:

  • 允许分享
  • 允许修改
  • 必须署名
  • 禁止商业使用
  • 修改后需保持相同许可

感谢你的贡献

每一次修改,都会帮助更多用户。

无论大小贡献,都非常重要。

欢迎一起完善 OG Star Wiki。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages