Is it expected that docs.fenicsproject.org points to the documentation of the main branch?

クローズ
#211 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
javascript

調査の方向性

まず、docs.fenicsproject.org がドキュメントをどのように選択して公開しているかを確認し、その後、issue にリンクされている NumPy の例に表示されるリリース選択と開発版に関する警告を比較します。main-branch の未リリースのドキュメントとリリース済みバージョンを明確に区別する方法について合意し、実装できれば完了です。

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

説明

I've just noticed that 0.10 is not yet released even though one might assume that it has been released according to a duckduckgo search for dolfinx:
Image

After checking the github project, I realized that no "Release" for 0.10 exists on github in https://github.com/FEniCS/dolfinx/releases.

I think this could be improved to avoid confusion.

Maybe you could take a look how other projects do it. numpy e.g. shows a red banner in the development documentation

Image

and when you access https://numpy.org/doc/ you explicitly have to select the release of numpy first:

Image
主要言語
JavaScript
スター
17
フォーク
9
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

FEniCS/web のほかの issue

FEniCS/web の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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