StackGuardian/tirith

[DOCUMENTATION] - Create a GitHub actions workflow to deploy docs to GitHub pages

開放

#200 建立於 2024年10月22日

在 GitHub 查看貢獻者指南
 (2 則留言) (0 個反應) (1 位負責人)Python (41 個分叉)auto 404
enhancementhacktoberfest

倉庫指標

星標
 (168 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

Description

I would create a GitHub actions workflow to deploy the documentation to the GitHub pages (or if you have any other platform, please suggest).

  1. The workflow will get triggered automatically as soon as any PR related to the docs is merged
  2. The workflow will also have a spell check so that if you raise a PR and the doc has some spelling mistakes, the workflow will throw an error, so it solves the manual check of spelling every time.

Hey @refeed feel free to add more such conditions if you want to.

貢獻者指南

研究方向
建立一個 GitHub Actions 工作流程檔案 (.github/workflows/docs deploy.yml)，當推送到 main 或影響 docs/ 的 PR 合併時觸發。包含一個拼寫檢查步驟，使用 pyspelling 或 codespell 等工具，並使用 peaceiris/actions gh pages 將文件部署到 GitHub Pages。確保工作流程有良好的文件且易於遵循。
技術棧
pythongithub actions
領域
documentationdevops
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitGitHub Actions basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85