zellij-org.github.io icon indicating copy to clipboard operation
zellij-org.github.io copied to clipboard

Why there is no link to this repo within mdbook page

Open BoolPurist opened this issue 2 months ago • 3 comments

Hi,

I am used that mdbooks documentation has a GitHub Icon in the upper right corner. This Icon leads to the repository where the source code of the mdbook documentation resides. See this manual from just as an example.

I think this would have helped me find the right repository faster. Took me a bit to find out that there is a separate repository, this one, for the documentation. Google tends to lead me rather to the source code repository instead of this one and the project website has no direct link to this repository either.

This fact makes it harder for people getting started with contributing to the documentation than it needs to be in my view.


If you want, I could implement this feature.

BoolPurist avatar Oct 01 '25 14:10 BoolPurist

Hi, thanks for bringing this up! This repository contains the source code for the zellij.dev website and the mdbook documentation. It also contains the compiled assets for both to serve as a static site. Because of this, one has to have the exact same version of mdbook and hugo when building the assets, otherwise the diffs become unwieldy and general chaos ensues.

This is obviously not an ideal situation (OSS project with limited resources and all) and @jaeheonji is working on fixing this. We do not have an ETA (I don't want to pressure @jaeheonji in any way and I'm sure he'll get to this when he has the time!) and I thank you for your patience in contributing fixes until this is fixed.

imsnif avatar Oct 01 '25 15:10 imsnif

I believe it is a good suggestion; however, optimizing the pipeline of this repository should take priority at the moment. I will complete this work within the next few weeks. I kindly ask for your patience and understanding. Thank you

jaeheonji avatar Oct 01 '25 15:10 jaeheonji

Thanks for the prompt answer. For me this is okay since I know where the contribution to the mdbook documentation goes. Glad to read that this will be solved in the future.

You have my patience with this ongoing background.

BoolPurist avatar Oct 01 '25 19:10 BoolPurist