alex-mckenna / clash-systolic Goto Github PK

In order to make the library as accessible as possible, there should be an ample amount of API-level documentation to explain concepts in the library. This includes the following:

• Module descriptions for all publicly visible modules
• A preamble for all modules providing overall context
• Documentation on all exported symbols from modules
• Examples of how to define and use systolic cells and networks
• Caveats, warnings, or other such non-obvious parts of the implementation
• TikZ-like images to help make documenting concepts clearer

For basic systolic networks, the library should provide unidirectional and bidirectional variants where possible. I suspect that these commonly will use the same configuration types as their unidirectional counterparts, but would need their own instances in order to correctly connect signals together. Bidirectional networks to be implemented:

• Bidirectional pipelines
• Bidirectional rectangular networks
• Bidirectional trees
• Bidirectional lattices

The project currently has doctests and unit tests, while no tests are implemented the CI infrastructure could be setup in advance. This entails:

• Writing a GitHub actions workflow
• Checking commits build and pass the test suites
• Checking that CI caching works as intended

It may additionally be nice to include status checks for things like hlint etc.