Skip to content

Commit

Permalink
Stub sections of documentation to fill later
Browse files Browse the repository at this point in the history
  • Loading branch information
MateuszKubuszok committed Oct 5, 2023
1 parent e6c9619 commit 5714829
Show file tree
Hide file tree
Showing 6 changed files with 143 additions and 2 deletions.
24 changes: 24 additions & 0 deletions docs/cookbook.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# Cookbook

## Automatic, Semiautomatic and Inlined derivation

TODO

## Java collection integration

TODO

## Cats integration

TODO

## Protocol buffers integration

TODO

## Custom smart constructors

TODO

## Custom optional types

TODO
23 changes: 23 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# Chimney

TODO: welcome test

```scala
// TODO: domain to protobuf example

import io.scalaland.chimney.dsl.*
domain.transformInto[Protobuf]
```

```scala
// TODO: protobuf into domain example

import io.scalaland.chimney.dsl.*
domain.transformIntoPartial[Protobuf]
```

```scala
// TODO: patching domain

import io.scalaland.chimney.dsl.*
domain.patchUsing(patch)
```
24 changes: 24 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# Quickstart

[![Chimney JVM versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=jvm)](https://search.maven.org/artifact/io.scalaland/chimney_2.13) <br>
[![Chimney Scala.js 1.x versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=sjs1)](https://search.maven.org/artifact/io.scalaland/chimney_sjs1_2.13) <br>
[![Chimney Scala.js 0.6 versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=sjs0.6)](https://search.maven.org/artifact/io.scalaland/chimney_sjs0.6_2.13) <br>
[![Chimney Scala Native 0.4 versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=native0.4)](https://search.maven.org/artifact/io.scalaland/chimney_native0.4_2.13) <br>
[![Chimney Scala Native 0.3 versions](https://index.scala-lang.org/scalalandio/chimney/chimney/latest-by-scala-version.svg?platform=native0.3)](https://search.maven.org/artifact/io.scalaland/chimney_native0.3_2.11) <br>

```scala
// if you use Scala on JVM-only
libraryDependencies += "io.scalaland" %% "chimney" % chimneyVersion
// if you cross-compile to Scala.js and/or Scala Native
libraryDependencies += "io.scalaland" %%% "chimney" % chimneyVersion
```
```scala
import io.scalaland.chimney.dsl._
```

TODO: see semiauto vs auto

TODO: cats-integration

TODO: java-collections

TODO: protobufs
6 changes: 5 additions & 1 deletion docs/supported-patching.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Supported patching
# Supported patching

TODO

TODO flags
54 changes: 54 additions & 0 deletions docs/supported-transformations.md
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
# Supported Transformations

## Into `case class`

TODO

TODO java beans

TODO flags

TODO overrides

## From/To `AnyVal`

TODO

## Between `sealed`/`enum`s

TODO

TODO java enums

TODO flags

TODO overrides

TODO java enums limitations

## From/To `Option`

TODO

TODO option unwrapping in partial

TODO refer Optional support in java-collections

TODO flags

## Between `Either`s

## Between Scala's collections

TODO

TODO mention Factory

TODO mention java-collections

## Custom transformations

TODO

TODO total -> partial

TODO implicit conflict resolution
14 changes: 13 additions & 1 deletion docs/troubeshooting.md
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
# Troubleshooting
# Troubleshooting

## Migration 0.7.x to 0.8.0

TODO

## sealed traits fail to recompile

TODO

## Debugging macros

TODO

0 comments on commit 5714829

Please sign in to comment.