Add "Getting started guide" and Headless Overview #330
Conversation
Goal is to simplify/give an overview before diving deeper.
apis/frontend/implementation-guide-session-api/overview-event-tracking-attribution.md
Outdated
Show resolved
Hide resolved
apis/frontend/implementation-guide-session-api/overview-event-tracking-attribution.md
Outdated
Show resolved
Hide resolved
apis/frontend/implementation-guide-session-api/overview-event-tracking-attribution.md
Outdated
Show resolved
Hide resolved
apis/frontend/implementation-guide-session-api/overview-event-tracking-attribution.md
Outdated
Show resolved
Hide resolved
getting-started/how-to-get-the-most-out-of-our-guides-and-nosto.md
Outdated
Show resolved
Hide resolved
getting-started/how-to-get-the-most-out-of-our-guides-and-nosto.md
Outdated
Show resolved
Hide resolved
apis/frontend/implementation-guide-session-api/overview-event-tracking-attribution.md
Outdated
Show resolved
Hide resolved
…wn list indention
* Improve structure through lists * Add references to Nosto client script API * Promote Nosto helper methods for injection and parameterless attribution to reduce complexity * Move "is not recommended for SPA" higher * Add "dynamic filtering is not possible with pure GraphQL RECs" note * Add example response, making the ev1 request/response more prominent * Update comparison table
* Replace Session API drawback "Complex event tracking and attribution" with "Requires a bit more planning because page tracking and campaign injection are combined" * Add "No dynamic filtering and OCP" for GraphQL
…ly complex non-Shopify product card)
Co-authored-by: Chris Ortner <christian.ortner@nosto.com>
| # Table of contents | ||
|
|
||
| * [Introduction](README.md) | ||
| ## Getting started |
There was a problem hiding this comment.
this section competes a bit with Implementing Nosto
is it a general intro section?
Also it is quite flat without any nesting
There was a problem hiding this comment.
Hey Timo, understand what you mean and I see there's some overlap but for now imo this is fine.
One main idea/background of the getting started guide is to use it in pre-sales. We want to set the expectations of the needed work and give a high level overview of what Nosto does etc., too often we had "mis-scopes" in the past. So we'd like to keep this guide separate from the main documentation to drive the narrative "read the full 'getting started guide' before our tech call".
How would you nest those pages? We tried to keep the structure as linear as possible, so as of now I can think of adding numbers for the menu to make this more clear, curious about your suggestions though, wdyt?
There was a problem hiding this comment.
If it's pre-sales guide then it should be maybe named differently.
The whole "Implementing Nosto" section is also a getting started guide.
There was a problem hiding this comment.
Maybe just a line at the very beginning of the section "Welcome & Support" that makes it clear that this is a guide which is meant for agencies that are implementing Nosto for clients.
There was a problem hiding this comment.
We want the first page of our docs to be the getting started/quick start guide. Readers (inhouse devs or agencies) have 0 context of Nosto and therefore need an overview of our docs and guidance through the different aspects of an implementation. They will read it in two situations:
- During pre-sales phase to make their estimate.
- When starting implementing Nosto (can be later down the road and can also be by a person that wasn't involved in the pre-sales discussion)
Of course, the details can vary and they are covered in the next "chapters" of the documentation.
I agree that there are certain aspects that are overlapping, imo the current "introduction" page can be deleted as it is getting replaced by the entire "getting started" chapter with the subpages and updated checklists rather than paragraphs.
What do you think of keeping the naming and removing https://github.com/Nosto/wiki-docs/blob/Techdocs/README.md (better said replacing it with https://github.com/Nosto/wiki-docs/blob/getting-started-guide-psn-and-headless/getting-started/README.md and maybe changing the headline "Welcome Guide")? @DJ-techie @timowestnosto
DJ-techie
left a comment
DJ-techie
left a comment
There was a problem hiding this comment.
"need to be available on all pages." I would suggest to make this bold!
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
jwittorf
changed the title
| # Table of contents | ||
|
|
||
| * [Introduction](README.md) | ||
| ## Getting started |
There was a problem hiding this comment.
We want the first page of our docs to be the getting started/quick start guide. Readers (inhouse devs or agencies) have 0 context of Nosto and therefore need an overview of our docs and guidance through the different aspects of an implementation. They will read it in two situations:
- During pre-sales phase to make their estimate.
- When starting implementing Nosto (can be later down the road and can also be by a person that wasn't involved in the pre-sales discussion)
Of course, the details can vary and they are covered in the next "chapters" of the documentation.
I agree that there are certain aspects that are overlapping, imo the current "introduction" page can be deleted as it is getting replaced by the entire "getting started" chapter with the subpages and updated checklists rather than paragraphs.
What do you think of keeping the naming and removing https://github.com/Nosto/wiki-docs/blob/Techdocs/README.md (better said replacing it with https://github.com/Nosto/wiki-docs/blob/getting-started-guide-psn-and-headless/getting-started/README.md and maybe changing the headline "Welcome Guide")? @DJ-techie @timowestnosto
| - to product recommendations ("You might also like") on any page type (or even in the mini-cart or search overlay) | ||
| - to conversion rate optimized, personalized category pages and SERPs which replace the native platform functionality. | ||
|
|
||
| * [Watch video: Overview of Nosto by example of a custom implementation](/.gitbook/assets/01-overview-custom-implementation.mp4) |
There was a problem hiding this comment.
@timowestnosto any thoughts on how we can host or even embed/include the videos? I've tried with <video /> earlier but it seems we can't host the videos within GitHub (which probably is a good constraint).
I can ask somebody from marketing to upload the videos unlisted to our YouTube account, WDYT?
https://nosto.slack.com/archives/C7S3D79GS/p1763546082059549
Review Status: