openmainframeproject / cobol-programming-course

Training materials and labs for a "Getting Started" level course on COBOL
https://openmainframeproject.org/projects/cobol-programming-course/
Creative Commons Attribution 4.0 International
3.04k stars 589 forks source link

Create a static site for the book using Docusaurus #317

Open literalEval opened 6 months ago

literalEval commented 6 months ago

Course Details

GitHub

Description

The current method of providing the chapters is with PDFs, which is good too. But we can build a better UX by hosting a documentation site using static site generators (say Docusaurus). This will allow us to build rich features like back links, beautiful design etc. Since GitHub allows hosting static sites for free, it won't add any friction to the workflow.

Problems

Surfing an online site with good design is better than downloading chapters as PDFs.

Additional Context

I have seen organizations do this for their code base documentation. Eg: The Palisadoes Foundation (the organization with which I completed my Google Summer of Code), uses this for hosting their documentation