search

finos / architecture-as-code

"Architecture as Code" (AasC) aims to devise and manage software architecture via a machine readable and version-controlled codebase, fostering a robust understanding, efficient development, and seamless maintenance of complex software architectures
https://calm.finos.org
Apache License 2.0
61 stars 33 forks source link

Add examples to CALM documentation #499

Open yt-ms opened 2 weeks ago

yt-ms commented 2 weeks ago

Feature Request

Description of Problem:

As a person wanting to find out what CALM actually is, when looking at the documentation, I want to see some meaningful examples including visualisations so I can understand better how CALM is used.

Potential Solutions:

There are already some small examples in the Core Concepts section, however having some more fully worked examples which include corresponding diagrams would greatly help with comprehension. We should use TraderX as one of the examples, however that is quite complex so we need some simpler ones leading up to that.

Thels commented 2 weeks ago

Completely agree with this - as someone new to the area ( and trying to build upon the logic within the CLI for extensions ) finding examples that were actually "correct" was a bit more of a pain than it should be.

https://github.com/finos/architecture-as-code/issues/484

I raised this issue a few days ago, to cover ensuring that the examples we do have in the code are at the very least correct. Do you think we should merge these?