Skip to content

A suggestion on documentation for CTF #312

@akothen

Description

@akothen

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions