Clarify `index` Gradle extension docs that it configures all generated pages, not just index.html

varabyte / kobweb

A modern framework for full stack web apps in Kotlin, built upon Compose HTML

https://kobweb.varabyte.com

Apache License 2.0

1.56k stars 70 forks source link

Clarify `index` Gradle extension docs that it configures all generated pages, not just index.html #597

Open okarmazin opened 2 months ago

okarmazin commented 2 months ago

The KDoc of IndexBlock and its properties only talks about "index.html", but the configuration therein affects all generated HTML pages. The "index" naming should probably be changed to something more fitting.

bitspittle commented 2 months ago

Great point. We discussed this issue and actually you might have helped us realize we have a bigger change in mind to fix this than just renaming.

I'll try to put together a doc proposal to capture some thoughts and will paste that link here.