[LD-146] Analytics Documentation

[nowakweronika]

Pull-Request

Description

Why?

We want to have analytics documentation in project.

What?

Firebase analytics documentation.

Links to related issues

• Fixes LD-146

Demo

Example part of our docs.

How to test

Take a look at the README file and let me know if you like it. 😼

Documentation

• Based on: Notion

Checklist

- [ ] Functionality is covered by unit tests
- [ ] Functionality is covered by integration tests

• I've updated PR description with relevant information
• I've done self code review
• I've manually tested if the code and app works

[github-actions]

Overall Project	73.06%	❌

There is no coverage information present for the Files changed

[github-actions]

🦙 MegaLinter status: ❌ ERROR

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ COPYPASTE	jscpd	yes		no	2.77s
⚠️ MARKDOWN	markdownlint	11	3	2	0.61s
✅ MARKDOWN	markdown-link-check	11		0	2.07s
✅ MARKDOWN	markdown-table-formatter	11	3	0	0.35s
✅ REPOSITORY	checkov	yes		no	13.0s
✅ REPOSITORY	devskim	yes		no	0.89s
✅ REPOSITORY	dustilock	yes		no	0.12s
✅ REPOSITORY	gitleaks	yes		no	1.26s
✅ REPOSITORY	git_diff	yes		no	0.08s
❌ REPOSITORY	secretlint	yes		1	1.0s
✅ REPOSITORY	syft	yes		no	0.33s
✅ SPELL	misspell	11	0	0	0.13s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

[github-actions]

Overall Project	73.06%	❌

There is no coverage information present for the Files changed

[jacek-marchwicki]

suggestion:

1. Let's move to a different file so our main README file doesn't contain too much data. e.g. [Analytics Documentation](docs/analytics.md)

2. It would be good to have images in the repo, so we can do normal code-review process. So move images to GitHub repo docs/analytics-imgs/users-in-last-30-minues.png

3. "Events Names" documentation, should have more information about every specific event. You can look at button_click. We should know details when something is tracked, what parameters are required. Some examples, etc.

4. Afaik, it would be good if every screen would have its own custom README page, e.g. docs/anlaytics/page/reviewers-screen.md

5. As a start section of a given screen, it's good to add a screenshot of that page, so it's easier to know exactly what screen we're referring in the following events.

6. You can consider displaying images a little bit smaller, because knowing precise content is not so important, but those images take a lot of page layout.

[github-actions]

Overall Project	73.06%	❌

There is no coverage information present for the Files changed

[github-actions]

Overall Project	73.06%	❌

There is no coverage information present for the Files changed

[github-actions]

Overall Project	73.06%	❌

There is no coverage information present for the Files changed

[github-actions]

Overall Project	73.06%	❌

There is no coverage information present for the Files changed

[github-actions]

Overall Project	73.06%	❌

There is no coverage information present for the Files changed