Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a static site for the book using Docusaurus #317

Open
literalEval opened this issue Apr 21, 2024 · 0 comments
Open

Create a static site for the book using Docusaurus #317

literalEval opened this issue Apr 21, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@literalEval
Copy link

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

@literalEval literalEval added the enhancement New feature or request label Apr 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant