-
-
Notifications
You must be signed in to change notification settings - Fork 656
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add docs for impression data #1328
Conversation
FredrikOseberg
commented
Feb 3, 2022
•
edited
edited
- Add documentation that details the new impression data feature
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/unleash-team/unleash-docs/4vEGoWA3qu3mJ4XrVRvdVzrEXm8u |
Coverage report
Test suite run success789 tests passing in 116 suites.Report generated by 🧪jest coverage report action from 8ef9fed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work 🙌🏼 I think this is a really good starting point and that it covers a lot of the most important parts of the feature. I think it could benefit from some work on the structure, though.
Personally, I'd like to see a clearer description of what impression data is, what form it takes (e.g. what data does it carry), and how you use it.
Outlined the way it is now, it's more like a how-to guide (which is great, but not the same as reference documentation as defined by diataxis). I can see a single paragraph on "how to enable it" being useful though.
That said, I'm very happy to discuss this, and I also wouldn't mind taking a stab at reorganizing it a bit if you'd want?
Edit
Oh, and I chucked in a couple minor suggestions that jumped out at me regarding syntax highlighting, documentation ordering, and a sentence potentially missing a word 🤓
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Thanks for the feedback! If you want to take a stab at reorganizing it that would fantastic. |
We've been very inconsistent with our use of separators previously (we should try and find a standard). Hyphens are most common online, so I've switched to that instead.
docs: suggested impression data reference doc restructure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! 🚂 Thanks for putting this together 🙌🏼