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

Adding a tiny README file for each module #844

Closed
Jolanrensen opened this issue Aug 27, 2024 · 0 comments · Fixed by #900
Closed

Adding a tiny README file for each module #844

Jolanrensen opened this issue Aug 27, 2024 · 0 comments · Fixed by #900
Assignees
Labels
documentation Improvements or additions to documentation (not KDocs) infrastructure GitHub actions, Gradle Scripts, Writerside, etc.
Milestone

Comments

@Jolanrensen
Copy link
Collaborator

I keep having to dig into each module like :tests, :generator, and :symbol-processor to figure out what they do again. If even I have this issue, as a full-time DataFrame developer, I can only imagine what it must be like for other contributors...

Let's add a small README file into each module in the project with a small description what it's for and how it's used.

For inspiration, this is what Dokka has: https://github.com/Kotlin/dokka/tree/master/dokka-subprojects/analysis-kotlin-api

@Jolanrensen Jolanrensen added the infrastructure GitHub actions, Gradle Scripts, Writerside, etc. label Aug 27, 2024
@Jolanrensen Jolanrensen added this to the 0.15.0 milestone Aug 27, 2024
@Jolanrensen Jolanrensen self-assigned this Oct 1, 2024
@Jolanrensen Jolanrensen mentioned this issue Oct 1, 2024
@Jolanrensen Jolanrensen added the documentation Improvements or additions to documentation (not KDocs) label Oct 1, 2024
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 (not KDocs) infrastructure GitHub actions, Gradle Scripts, Writerside, etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant