Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Update docs to use Render Engine

オープン
  • 何か問題がありますか？
#1,151 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
静か
技術スタック
python
領域
build-system, documentation

調査の方向性

まずドキュメントのビルドスクリプトと参照されている mkdocs.yml を特定し、現在の MkDocs ディストリビューションがどのように組み立てられているかを調べます。作業を、提案された theme、mkdocs.yml を処理する plugin、スクリプトの更新に分け、ドキュメントのディストリビューションで MkDocs ではなく Render Engine が使用されていることを確認します。

索引モデルが issue の本文から書いたものです。

説明

feature

Seeing as we write an SSG there is no reason for us to use mkdocs to create our documentation for distribution. We should be using Render Engine.

The switch will not necessarily be simple, however we should be able to accomplish it in stages.

  1. A theme for the docs
  2. A plugin to handle the mkdocs.yml
  3. Updating scripts to us RE and not mkdocs
主要言語
Python
スター
64
フォーク
46
平均マージ
1日 18時間
マージ済み PR（30日）
17

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

render-engine/render-engine のほかの issue

render-engine/render-engine の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。