trixi-framework/Trixi.jl

Create a dedicated repository for binary documentation assets?

Open

#194 建立於 2020年9月29日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)Julia (153 fork)batch import
documentationgood first issue

倉庫指標

Star
 (686 star)
PR 合併指標
 (平均合併 19天 17小時) (30 天內合併 36 個 PR)

描述

In light of issues such as #169, I wonder if we should establish a way to store binary blobs (aka image files) that we want to use in the documentation. Right now, we already use 2-3 images in the README.md and the docs, but each time I consider adding a new one I feel slightly bad about permanently increasing the repo size by 50-100 KiB. This is exacerbated by the fact that images, just like other documentation, often become outdated very fast and need to be replace regularly.

One possible solution could be to have a dedicated repository to store documentation assets such as images or videos, e.g., trixi-framework/documentation-assets, that we allow to grow in size over time. A different approach could be to store binary assets in a dedicated branch within the main repo, which gets regularly purged by deleting its history (however, this would raise the question of if and how docs for older releases should be kept alive).

Another thought (although slightly orthogonal to the main question here), is whether it would be beneficial to have a dedicated repository to host the documentation, such as Oceananigans.jl does it with OceananigansDocumentation.

貢獻者指南