Add documentation for the JS SDK
Problem
Currently, there is no documentation about the Gitlab Analytics SDK in the official Gitlab docs. There is just some basic documentation around the general architecture. Our current documentation of the SDK is also hidden in a markdown file in the repo.
As we move towards the first tests with customers, there should be documentation on how to instrument an application with the Javascript SDK as part of our official documentation.
Proposal
We can use existing markdown file in the repo as a base but should make sure that:
- all current features of the SDK are documented, this includes:
- how to disable plugins
- how to activate tracking when cookie consent is given
- how to instrument an event
- examples of what is tracked automatically
Desired Outcome
Documentation for the usage of the JS SDK is clear and concise in the Readme.md file for the package.
How to verify
Ask another Frontend engineer if they'd feel confident to set up the sdk based on the docs and use them to set up the SDK ourselves for additional projects