coala / coala/projects

Automated developer docs generation based on test cassettes for interconnected components/systems

Open
#519 5 comments 0 reactions 2 assignees Claimed by @jschwarzwalder View on GitHub
Project Proposal
Dominant language
JavaScript
Stars
118
Forks
225
PR merge metrics
No merged PRs in 30d

Description

@coala and @gitmateIO Python repos have a specific structure for their tests, and 100% test coverage.

Typically automated docs are generated from the source code as the entry point into the system.

When there is a high percentage of test coverage, using the tests as the starting point for documentation will allow all important parts of the API and its source code to be reached.

The unit and integration tests should be written to be informative to the reader, as they also need to be maintained. Using them as the basis of the documentation requires writing readable tests that tell stories, accurately, and those stories can then be checked during code review to ensure the test sequence does in fact demonstrate the story being described. Validators will need to do some basic checking of the test code (Note coala requires unittest compatibly, but allows pytest to add extra features).

The docs generator could additionally convert test cassettes into

- component and flow diagrams to show how high level components are interconnected based on typical usage
- asciinema-like animation so the reader can see how real data flows between the interconnected components when performing a high level operation

This system generated by this project would need to work well for IGitt and coala-bears repositories, and work with caveats for coala and gitmate.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.