Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add examples to CALM documentation #499

Open
yt-ms opened this issue Oct 18, 2024 · 1 comment
Open

Add examples to CALM documentation #499

yt-ms opened this issue Oct 18, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@yt-ms
Copy link
Contributor

yt-ms commented Oct 18, 2024

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.

@yt-ms yt-ms added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 18, 2024
@Thels
Copy link
Member

Thels commented Oct 18, 2024

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.

#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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants