openmainframeproject / openmainframeproject/cobol-programming-course
Create a static site for the book using Docusaurus
Nobody has claimed this yet.
- Dominant language
- COBOL
- Stars
- 3.6k
- Forks
- 721
- Avg merge
- 11d 16h
- Merged PRs (30d)
- 1
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the course chapters are currently provided as PDFs and the linked Docusaurus documentation example. Define the static site's scope, chapter structure, hosting approach, and the features needed before implementation; done means the course is available as a usable documentation site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation, web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100