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

A suggestion on documentation for CTF #312

Open
akothen opened this issue Feb 26, 2025 · 0 comments
Open

A suggestion on documentation for CTF #312

akothen opened this issue Feb 26, 2025 · 0 comments

Comments

@akothen
Copy link

akothen commented Feb 26, 2025

It is probably better not to assume that people will read the paper and the documentation to understand and use the tool. So both of them have to be pretty self-contained. The paper looks good to me, and so does the documentation, but the documentation makes references to causal DAGs without depicting what they look like, etc (https://causal-testing-framework.readthedocs.io/en/latest/modules/causal_specification.html#causal-dag). I believe the point of the documentation is to have much more technical information that the general audience can understand and enables people to use and play around with the tool. The documentation must be accessible to those who may not necessarily be interested in the low-level, inner workings of this framework, but want to understand its capabilities and just use it.

@akothen akothen changed the title A suggestion on the documentation for CTF A suggestion on documentation for CTF Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant