cuspatial
cuspatial copied to clipboard
[DOC] Improve C++ developer documentation
We would like to improve cuSpatial's developer documentation to make it easier to contribute to cuSpatial.
I think we should follow the lead of cuDF, which has a relatively comprehensive set of documentation for developers. That means providing the following documents.
- [ ] cpp/docs/DEVELOPER_GUIDE.md: a guide for developers contributing C++ / CUDA C++ code to cuSpatial, covering key terms, directory structure and file naming, code and documentation style and formatting, key data structures, API style (e.g. parameters, inputs and outputs), error handling, deprecation guidelines, and data types.
- [ ] cpp/docs/DOCUMENTATION.md: a guide to writing and building libcuspatial documentation using Doxygen.
- [ ] cpp/docs/TESTING.md: A guide to writing unit tests for libcuspatial.
- [ ] cpp/docs/BENCHMARKING.md: A guide to writing unit benchmarks for libcuspatial.