Paradox docs link in README is dead

[Friendseeker]

https://developer.lightbend.com/docs/paradox/current/ throws 404

[SethTisue]

I'm inquiring with IT staff at Akka.

[ennru]

The site was intentionally taken down.
Please browse the docs directly in the GitHub repo https://github.com/lightbend/paradox/blob/main/docs/src/main/paradox/index.md

[Friendseeker]

The site was intentionally taken down. Please browse the docs directly in the GitHub repo https://github.com/lightbend/paradox/blob/main/docs/src/main/paradox/index.md

Thanks for reply, Enno! One problem is that Github does not seem to like that particular flavour of markdown. Directly viewing the doc via Github results in annotations such as @@toc { depth=1 } not rendered.

I wonder if it would be better to make a Github Page out of the existing markdown documentation?

[ennru]

Yes, it would be great to publish the site to Github pages. Please suggest the necessary changes and I'll try to get it sorted.

[Friendseeker]

Yes, it would be great to publish the site to Github pages. Please suggest the necessary changes and I'll try to get it sorted.

I am not familiar with Markdown documentation, so Seth may need to correct me, but I guess it should be basically creating a new GitHub Repo to host the GitHub Page, run some static site generator (I guess paradox itself?) on the current markdown docs, and place the generated site directory in the created repo.

[SethTisue]

run some static site generator (I guess paradox itself?)

Yes.

creating a new GitHub Repo to host the GitHub Page

We don't need a separate repo, just a website branch in this repo. GitHub Pages can be configured to point to that branch (from https://github.com/lightbend/paradox/settings/pages).

[SethTisue]

I recently did a similar transition for our Fortify docs, which are also Paradox based, and I can confirm that there really isn't anything to it besides running sbt paradox and then syncing the website branch with target/paradox/site/main

at least, there wasn't anything else I had to do there, I don't think this repo is special

[SethTisue]

Maybe https://www.scala-sbt.org/sbt-site/ would be helpful here? I have no firsthand experience with it. It seems to have Paradox support: https://www.scala-sbt.org/sbt-site/generators/paradox.html