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.

Sign up for GitHub

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

Jump to bottom

Beef up root and module's README.md and add to Dokka #624

Open
JakeWharton opened this issue Jan 5, 2025 · 0 comments
Open

Beef up root and module's README.md and add to Dokka #624

JakeWharton opened this issue Jan 5, 2025 · 0 comments
Labels
build and CI documentation Improvements or additions to documentation good first issue PR welcome

Comments

@JakeWharton
Copy link
Owner

No description provided.

@JakeWharton JakeWharton added documentation Improvements or additions to documentation build and CI good first issue PR welcome labels Jan 5, 2025
EpicDima added a commit to EpicDima/mosaic that referenced this issue Jan 5, 2025
@EpicDima
Add README's to dokka
d07520a 
- Move the gifs from separate directories to images so that the pictures were pulled up in the documentation, there is also a folder called images
- Rename the gifs by the name of the sample from which it was created, since the same names cannot be in the same folder
- Update the script for creating gifs for updating in a new directory
- Update README.md for samples for pulling up gifs from the images root directory
- In the root README.md add a width for images, because without it, the images in the documentation stretch to the full width of the page
- Add a simple README.md to the `mosaic-testing` and `mosaic-runtime` modules
- Update the header in README.md the `mosaic-animation` and `mosaic-terminal` modules for correct processing (https://kotlinlang.org/docs/dokka-module-and-package-docs.html#file-format)
- Add saving to assets for dokka of all images from the root README.md automatically

Solution for JakeWharton#624
EpicDima added a commit to EpicDima/mosaic that referenced this issue Jan 5, 2025
@EpicDima
Add README's to dokka
30930da 
- Move the gifs from separate directories to images so that the pictures were pulled up in the documentation, there is also a folder called images
- Rename the gifs by the name of the sample from which it was created, since the same names cannot be in the same folder
- Update the script for creating gifs for updating in a new directory
- Update README.md for samples for pulling up gifs from the images root directory
- In the root README.md add a width for images, because without it, the images in the documentation stretch to the full width of the page
- Add a simple README.md to the `mosaic-testing` and `mosaic-runtime` modules
- Update the header in README.md the `mosaic-animation` and `mosaic-terminal` modules for correct processing (https://kotlinlang.org/docs/dokka-module-and-package-docs.html#file-format)
- Add saving to assets for dokka of all images from the root README.md automatically
- Change `dokkaSourceSets.named('commonMain').configure` -> `dokkaSourceSets.configureEach` to correctly display information from README.md for different targets (common, jvm, native)

Solution for JakeWharton#624
@EpicDima EpicDima mentioned this issue Jan 5, 2025
Closed
1 task
EpicDima added a commit to EpicDima/mosaic that referenced this issue Jan 6, 2025
@EpicDima
Add README's to dokka
f42dfca 
- Move the gifs from separate directories to images so that the pictures were pulled up in the documentation, there is also a folder called images
- Rename the gifs by the name of the sample from which it was created, since the same names cannot be in the same folder
- Update the script for creating gifs for updating in a new directory
- Update README.md for samples for pulling up gifs from the images root directory
- In the root README.md add a width for images, because without it, the images in the documentation stretch to the full width of the page
- Add a simple README.md to the `mosaic-testing` and `mosaic-runtime` modules
- Update the header in README.md the `mosaic-animation` and `mosaic-terminal` modules for correct processing (https://kotlinlang.org/docs/dokka-module-and-package-docs.html#file-format)
- Add saving to assets for dokka of all images from the root README.md automatically
- Change `dokkaSourceSets.named('commonMain').configure` -> `dokkaSourceSets.configureEach` to correctly display information from README.md for different targets (common, jvm, native)

Solution for JakeWharton#624
EpicDima added a commit to EpicDima/mosaic that referenced this issue Jan 6, 2025
@EpicDima
Add README's to dokka
8703b2d 
- Move the gifs from separate directories to images so that the pictures were pulled up in the documentation, there is also a folder called images
- Rename the gifs by the name of the sample from which it was created, since the same names cannot be in the same folder
- Update the script for creating gifs for updating in a new directory
- Update README.md for samples for pulling up gifs from the images root directory
- In the root README.md add a width for images, because without it, the images in the documentation stretch to the full width of the page
- Add a simple README.md to the `mosaic-testing` and `mosaic-runtime` modules
- Update the header in README.md the `mosaic-animation` and `mosaic-terminal` modules for correct processing (https://kotlinlang.org/docs/dokka-module-and-package-docs.html#file-format)
- Add saving to assets for dokka of all images from the root README.md automatically
- Change `dokkaSourceSets.named('commonMain').configure` -> `dokkaSourceSets.configureEach` to correctly display information from README.md for different targets (common, jvm, native)

Solution for JakeWharton#624
Fix for JakeWharton#627
EpicDima added a commit to EpicDima/mosaic that referenced this issue Jan 6, 2025
@EpicDima
Add README's to dokka
9e0c924 
- Move the gifs from separate directories to images so that the pictures were pulled up in the documentation, there is also a folder called images
- Rename the gifs by the name of the sample from which it was created, since the same names cannot be in the same folder
- Update the script for creating gifs for updating in a new directory
- Update README.md for samples for pulling up gifs from the images root directory
- In the root README.md add a width for images, because without it, the images in the documentation stretch to the full width of the page
- Add a simple README.md to the `mosaic-testing` and `mosaic-runtime` modules
- Update the header in README.md the `mosaic-animation` and `mosaic-terminal` modules for correct processing (https://kotlinlang.org/docs/dokka-module-and-package-docs.html#file-format)
- Add saving to assets for dokka of all images from the root README.md automatically
- Change `dokkaSourceSets.named('commonMain').configure` -> `dokkaSourceSets.configureEach` to correctly display information from README.md for different targets (common, jvm, native)

Solution for JakeWharton#624
Fix for JakeWharton#627
EpicDima added a commit to EpicDima/mosaic that referenced this issue Jan 6, 2025
@EpicDima
Migrate to Dokka v2
88c808e 
JakeWharton#580
JakeWharton#624
EpicDima added a commit to EpicDima/mosaic that referenced this issue Jan 6, 2025
@EpicDima
Migrate to Dokka v2
634e776 
JakeWharton#580
JakeWharton#624
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
build and CI documentation Improvements or additions to documentation good first issue PR welcome
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JakeWharton