【建议】使用 GitHub Pages 搭载项目

[skyleaworlder]

您有什么更好的想法吗

直接从 GitHub 看 README 太痛苦了，分享链接也是一长串，不如搭个 Pages。

详述目前的问题和可能的解决办法

Ref: https://zju-turing.github.io/TuringCourses/

您还有什么要说的吗

无。

[CookiePieWw]

Sure its a good idea! I'd like to help, but there are still a lot of binary files in the repo (1.47GB!). I think its better to resolve this first.

[skyleaworlder]

Sure its a good idea! I'd like to help, but there are still a lot of binary files in the repo (1.47GB!). I think its better to resolve this first.

Yes, you're right. It's totally my fault. About three years ago, I uploaded a large number of binaries. (since one of the original intentions of TJCS-Course was to gather certain hard-to-fetch materials, especially from mip246, which was extermely unstable at that time). I also uploaded a great number of verilog files. Although some measures were taken later (#4) to reduce the repo size from 2.1 GB to the current scale, it's still too large.

If you'd like to help, which is good and appreciated, you can refer to some websites (e.g. filter-branch) for guidance.

In general, times are changing, and the reasons from the past cannot be unconditionally extended into the future. I agree that it is necessary to delete aforementioned unnecessary files.

[CookiePieWw]

Yes, you're right. It's totally my fault. About three years ago, I uploaded a large number of binaries. (since one of the original intentions of TJCS-Course was to gather certain hard-to-fetch materials, especially from mip246, which was extermely unstable at that time). I also uploaded a great number of verilog files. Although some measures were taken later (#4) to reduce the repo size from 2.1 GB to the current scale, it's still too large.

Understood. I'd rather thank you for your initial intentions to create this. It helped me a lot.

If you'd like to help, which is good and appreciated, you can refer to some websites (e.g. filter-branch) for guidance.

Got it. Since it's not closely related to this issue, I'll open another one focusing on the binary files.

[CookiePieWw]

Hi @skyleaworlder, I tried to make the repo ready for github pages here, using github actions and mkdocs refering this repo. The gh-pages branch will be reconstructed on pushes.

You can go through the pages locally like this:

1. Clone the repo and checkout to mkdocs branch
2. Run python ./mkdocs.py to migrate files for mkdocs
3. Install mkdocs and mkdocs-material using pip
4. run mkdocs serve

The page will be deployed on http://127.0.0.1:8000/ by default.

[skyleaworlder]

Hi @skyleaworlder, I tried to make the repo ready for github pages here, using github actions and mkdocs refering this repo. The gh-pages branch will be reconstructed on pushes.

You can go through the pages locally like this:

1. Clone the repo and checkout to mkdocs branch
2. Run python ./mkdocs.py to migrate files for mkdocs
3. Install mkdocs and mkdocs-material using pip
4. run mkdocs serve

The page will be deployed on http://127.0.0.1:8000/ by default.

Great job! Thanks for your dedicated contribution first. I'd like to ask if this web page has been successfully deployed in your repository? I tried accessing https://cookiepieww.github.io/TJCS-Course/ but received a 404 error.

Additionally, I'd like to mention that the current repository structure uses "<course-code>_<course-name>" and keeps them together in the root directory to account for potential changes in the curriculum. While it is possible for the course code and name to change, typically when that happens, the course also undergoes a change in its evaluation system.

[CookiePieWw]

Great job! Thanks for your dedicated contribution first. I'd like to ask if this web page has been successfully deployed in your repository? I tried accessing https://cookiepieww.github.io/TJCS-Course/ but received a 404 error.

Sry, it seems I closed it while fixing the workflows. It should work now.

Additionally, I'd like to mention that the current repository structure uses "<course-code>_<course-name>" and keeps them together in the root directory to account for potential changes in the curriculum. While it is possible for the course code and name to change, typically when that happens, the course also undergoes a change in its evaluation system.

Got it. I think it is better to make a hierarchy structure on website, so classifying the courses with a config file (instead of directories) seems to be an acceptable solution, which can keep the current structure while generating the hierarchy structure. What do you think about it?

[skyleaworlder]

Great! I can see the deployment now, which looks good. (However, many of the contents inside were written during my undergraduate years, and now they feel quite embarrassing.

And I agree with your perspective on the organization of the repository directory. Of course you can create a new PR and refactor the current repository structure to a new one.