varabyte / kobweb

A modern framework for full stack web apps in Kotlin, built upon Compose HTML
https://kobweb.varabyte.com
Apache License 2.0
1.53k stars 68 forks source link

docs(architecture): Update outdated reference to Kobweb CLI/Binary in ARCHITECTURE.md file #544

Closed EchoEllet closed 3 months ago

EchoEllet commented 4 months ago

It looks like 3 Years ago, the Kobweb CLI/Binary was in a folder called cli in the same repository, later it was moved to kobweb-cli in a separate repository, this PR is one minimal way of updating the reference

Not directly related:

The gradle-plugins folder also seems to be moved somewhere else

image

The description might also be outdated, the description indicates markdown Gradle plugin is not supported yet but will be in the future

If I were you, I would add links in markdown files like this

[cli](./cli)

Not only would it make it easier to navigate while viewing the file in both Github and the local clone of the repository, it also makes it easier to find outdated links and references

even in simple projects as it can get bigger quickly later.

Alternatively use more complex solutions to generate the markdown files in source code in any language that is statically typed to eliminate the outdated code, references, and hardcoded values