search

PostHog / posthog.com

Official docs, website, and handbook for PostHog.
https://posthog.com
Other
425 stars 434 forks source link

Concept for showing all content about a topic in one place #2622

Open corywatilo opened 2 years ago

corywatilo commented 2 years ago

Between our marketing pages, docs, user guides, tutorials, handbook, and blog posts, we have a lot of valuable content across our site. But it's segmented, and not easy to navigate between different sections on the same topic. (For example, if I finish reading the user guide about Feature Flags and want to check out the API docs for it, there isn't a seamless link.)

Our product detail pages introduced the concept of linking a bunch of topics from Docs (see Feature flags documentation). This is useful so you can dive in deeper after learning the high-level stuff from the feature page.

But what if we tagged major product features in MDX front matter so they'll appear "pinned" in something that feels like search results?

Your entry page could be a blog post that talks about feature flags, and then you want to learn more about the feature. Or you might be reading API docs and want to see some real-world examples by means of a tutorial.

In the concept below, this blog post (left mock) is tagged as mentioning feature flags. (This is fictional - this post didn't mention feature flags, but let's pretend it did.) So above the post is a callout to the Feature Flags topic. Clicking that takes me to what looks like search results (middle wireframe):

image

This shows a combination of a custom Algolia search results view (from "Search results" on down), while including a fixed block of content that would appear for major product features. This includes a definition/summary of the feature, a CTA to access the user guide (as that's where the meat of the content lives) and shows plan/edition availability. (This design doesn't feel perfect, but you get the idea.)

Essentially this blends the ideas of site-wide search and having a custom block of content for certain search terms.

Note: I first referred to this concept as "Magic mode" in previous Tutorials mocks (png).

joethreepwood commented 2 years ago

Would this pull in case studies too, as per https://github.com/PostHog/posthog.com/issues/2487 ?

jamesefhawkins commented 2 years ago

Related: I made this repo which lets you create in-article keyword links from any markdown file. I'll make it work on tags too.