Skip to content

Commit

Permalink
docu
Browse files Browse the repository at this point in the history
  • Loading branch information
MFlisarWork committed Nov 19, 2024
1 parent 74789a3 commit cf92f7f
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/_include/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

!!! warning

I try to use as few experimental APIs as possible, but this library does use a few experimental APIs which are still marked as experimental in material3 `1.3.0`. I will provide new versions as soon as possible if experimental APIs change or become stable.
I try to use as few experimental APIs as possible, but this library does use a few experimental APIs which are still marked as experimental in material3 `{{ project["dependencies"]["compose"]["material3"] }}`. I will provide new versions as soon as possible if experimental APIs change or become stable.

{% endif %}

Expand Down
17 changes: 17 additions & 0 deletions documentation/docs/migration/v7.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
icon: material/arrow-up-box
---

!!! info

Version `7.*` is a kotlin multiplatform rewrite, that's why some fundamantal changes needed to be done!

Some things have become extension functions to provide target specific implementations and overloads:

* `FileLoggerSetup.<Daily/...>.create` => new import because it is an extension function now:`import com.michaelflisar.lumberjack.loggers.file.create`
* `getAllExistingLogFiles` => new import because it is an extension function now: `import com.michaelflisar.lumberjack.core.getAllExistingLogFiles`
* `Level.priority` => new import because it is an extension function now: `import com.michaelflisar.lumberjack.core.classes.priority`

I did also fix a typo, namely following:

* `getLatestLogFiles` => `getLatestLogFile` (also become an extension function btw)
3 changes: 3 additions & 0 deletions documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,9 @@ nav:
- Viewer: modules/viewer.md
- Advanced:
- Custom Logger Example: advanced/custom-logger.md
- Migration:
- Version 7: migration/migration-v7.md
- More:
- Migration: other-libraries.md
- Other Libraries: other-libraries.md
- About Me: me.md

0 comments on commit cf92f7f

Please sign in to comment.