On Fri, Feb 16, 2024 at 8:23 PM wrongwrong <[email protected]> wrote: > > I am wondering where and how the documentation should be placed regarding > value class support in kotlin-module. > https://github.com/FasterXML/jackson-module-kotlin/pull/768 > > The value class is a Kotlin-specific feature, and kotlin-module has complex > handling to support it. > Also, there are some value class-specific behaviors and flaws. > To avoid inconvenience to users and maintainers, I have created documentation > for both the technical and usage aspects. > > However, I am not sure where to place this documentation. > It is too much text to put in the README. > I thought the docs directory would be appropriate, but I found the following > instructions > https://github.com/FasterXML/jackson-core/blob/2.17/docs/README.md > > Does the Jackson project have any policies?
Nothing very formal, but I think some components use repo Wiki for this; combination of README + wiki entries seems like a reasonable way to go. There is also: https://github.com/FasterXML/jackson-docs which was intended for documentation (main README.md pointing to external resources and Wiki entries). The idea being that a more centralized set of documents would be easier to use than ones split across many repos. - + Tatu +- > > -- > You received this message because you are subscribed to the Google Groups > "jackson-dev" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/jackson-dev/b88123fc-6a33-4a94-aeb5-dea9e0f84167n%40googlegroups.com. -- You received this message because you are subscribed to the Google Groups "jackson-dev" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/jackson-dev/CAL4a10g%3DOVYuLvpZY6tFHgGZyi4tVu_EKdn%3DwXqObLEgtw3f%3DQ%40mail.gmail.com.
