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

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

Open
okarmazin opened this issue Aug 28, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@okarmazin
Copy link
Contributor

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.

image
@okarmazin okarmazin added the documentation Improvements or additions to documentation label Aug 28, 2024
@bitspittle bitspittle self-assigned this Aug 29, 2024
@bitspittle bitspittle added this to the 1.0 milestone Aug 29, 2024
@bitspittle
Copy link
Collaborator

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.

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

No branches or pull requests

2 participants