React package readme edit

grafana / faro-web-sdk

The Grafana Faro Web SDK, part of the Grafana Faro project, is a highly configurable web SDK for real user monitoring (RUM) that instruments browser frontend applications to capture observability signals. Frontend telemetry can then be correlated with backend and infrastructure data for full-stack observability.

https://grafana.com/oss/faro/

Apache License 2.0

690 stars 62 forks source link

React package readme edit #535

Closed grafsean closed 2 months ago

grafsean commented 3 months ago

@codecapitano I've made a few minor formatting edits.

How do these sections "### React Router without Data Routers", "### React Router with Data Routers" differ from "### Router"?

Could we have call to go over document structure and revisit where sections are nested?

CLAassistant commented 3 months ago

All committers have signed the CLA.

CLAassistant commented 3 months ago

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

codecapitano commented 3 months ago

@grafsean is this PR ready to merge from your side?

If yes, I can fix the linter issues, merge this PR and then we can copy the content to the fe-o11y docs as well. I can open a PR on the website if you like.

grafsean commented 3 months ago

Hi @codecapitano I am adding more copy today and will have follow up questions. After that I think we will be good to merge.

grafsean commented 3 months ago

@codecapitano I added more detail and a few questions. Could we call tomorrow morning to discuss next steps?

codecapitano commented 3 months ago

I added more detail and a few questions. Could we call tomorrow morning to discuss next steps? Sure and thank you Sean 🙏

grafsean commented 3 months ago

@codecapitano thanks, I did another round of additions and edits and left comments for you in the file.

Could you address those comments and then apply the same approach to the "Upgrade to a data router" section, where we explore what questions a user may have given the information presented. After you've done your first pass to that section (stop before "React router without data router"), I will edit and add comments and we can meet to discuss.

It's taking shape and becoming a solid tutorial 😄