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

Faster development cycle for static websites built with Scaladoc #19

Open
bishabosha opened this issue Jan 25, 2024 · 1 comment
Open

Comments

@bishabosha
Copy link
Member

bishabosha commented Jan 25, 2024

Scaladoc is usable as a static website generator, e.g. see https://dotty.epfl.ch, however it always builds from scratch.

To make it practical to build a large website, e.g. https://docs.scala-lang.org, we need a mode that supports a fast development cycle. Ideally the author can quickly iterate on an article, and see near-realtime updates in the browser.

We can propose two options at least:

  • an incremental documentation build, so only the changes get built.
  • to avoid manual browser refreshing we could integrate a hot reloading mechanism.

Whichever changes we apply, we should preserve the property that the "production" build generates the full static html before serving the page.

@ktotam1
Copy link

ktotam1 commented Sep 9, 2024

Hello,
I am a 2nd-year master's student at EPFL. I hope it is not too late, but I would like to work on this project this fall semester. Please let me know if there are any prerequisites to work on this project, or contact me by email for more information about me at [email protected].
Cheers,
Alexander

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants