-
Notifications
You must be signed in to change notification settings - Fork 82
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
This issue tracks the remaining todos and cleanup tasks needed to complete the documentation:
Pending Documentation Pages
The following pages are planned but still need to be written:
🔎 Querying Data
🔄 Transforming Data
📊 Aggregating Data
➕ Enriching Data
Event data spec
Complete the spec.yaml file for the following data providers:
- Stats Perform / Opta
- Wyscout (v2)
- Wyscout (v3)
- DataFactory
- Sportec Solutions
- Metrica
First describe which event types are deserialized and how the deserialization is implemented. Next, for each event type, describe which attributes are deserialized and how the deserialization is implemented.
UI Issue
- There is some whitespace at the bottom of the homepage. It is a bug in the CSS but I haven't been able to figure out how to get rid of it.
Misc
- The highlighted text in the "How kloppy supports your data analysis" section on the page and the README file should link to how-to guides that illustrate it.
- The installation guide page should discuss optional dependencies (
pandas,polars,networkx) and how to install them. - Clean up the "adding a data provider" guide and add instructions for adding a tracking data deserializer.
- Add the list with supported data providers to the home page
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation