A Q&A widget for your docs

Overview

image

Squeak! [BETA]

Squeak! lets you answer user questions, right in your docs. Even better: it lets your community support itself.

Top features

  • Embeds in any page of your docs or website
  • Only questions asked on a specific page will appear
  • Import Slack threads (from your community) and embed them on specific pages of your site (so they don't end up in the Slack abyss!)
  • Your community benefits from shared knowledge, leading to fewer support requests and repeated questions

Docs

Visit the wiki for guides on:

  1. Embeddable widget (JavaScript, React)
  2. Admin portal
  3. Integrations
  4. Self-hosting
  5. API
  6. Local development

Links

About

Squeak! was created by PostHog out of a need to better support our own customers and move conversations out of our Slack community. Squeak! is open source under MIT.

Comments
  • Admin console

    Admin console

    We should provide a method of managing (deletion etc) questions/answers from the admin UI

    We should also allow for editing of questions/responses to fix typos and to remove out-of-date information that may be confusing.

    • [x] View/delete questions/responses @smallbrownbike
    • [x] Users table (with role?) @joesaunderson
    • [x] Edit user: email, name, role @joesaunderson
    • [x] Settings pages (modify API keys for services, copy/paste JS code) @joesaunderson
    • [x] Invite user link to invite your team, then make it clear you need to upgrade their role @joesaunderson
    opened by joesaunderson 3
  • Roadmap page

    Roadmap page

    • Adds /roadmap page that displays all goals for every team
    • Allows goals to be created without assigning a team
    • Allows goals to be moved between teams
    opened by smallbrownbike 2
  • Topics!

    Topics!

    • Adds the ability to create and delete question topics
    • Once topics are created, they all appear under the "Appears on" section, where a user can select and associate any of the relevant topics to the question
    Screen Shot 2022-05-25 at 5 51 35 PM
    opened by smallbrownbike 2
  • Improve email notifications

    Improve email notifications

    • [x] Improve deliverability (Sender and From fields don't match) Message shows as coming from: PostHog [email protected] via mail.squeak.cloud. squeak.cloud is verified through Mailgun, but it's appearing to come from posthog.com and I don't see an option to change this in Mailgun.
    • [x] Link to page where question was asked Currently the email only links to the root domain
    • [x] Incorrect company domain (${company_domain}) See 2nd screenshot - says the question was asked on a Mailgun URL?
    image image
    opened by corywatilo 2
  • Admin: Issue saving post metadata

    Admin: Issue saving post metadata

    When clicking the save button, it spins but doesn't update to show a successful saved state, though the changes do seem to have been saved. (This is likely related to me moving these options out of the modal.)

    image
    opened by corywatilo 2
  • Sanitize question permalink slugs

    Sanitize question permalink slugs

    Since question slugs are generated from the titles, we need to handle special characters and other things that shouldn't be in URLs. For example:

    https://posthog.com/questions/typeerror:-cannot-read-property-'identify'-of-undefined-getting-this-when-i-use-posthog.identify

    In above:

    • [ ] :
    • [ ] '
    • [ ] .
    opened by corywatilo 1
  • Add image support

    Add image support

    • Allows attaching images to roadmap items
    • Adds faux Cloudinary integration by allowing users to enter their Cloudinary credentials on /settings
    • If Cloudinary creds are not present in the org, image upload features are hidden
    Screen Shot 2022-11-09 at 7 26 22 PM Screen Shot 2022-11-09 at 7 26 38 PM
    opened by smallbrownbike 1
  • Can't delete a question

    Can't delete a question

    In trying to delete a question from Squeak! admin, I get an error:

    client.ts:76          DELETE https://squeak.cloud/api/question/11 500
    VM57:2 Uncaught (in promise) SyntaxError: Unexpected token 'I', "
    Invalid `p"... is not valid JSON
    
    opened by corywatilo 1
  • Feature request: Auto populate permalink pages with question title

    Feature request: Auto populate permalink pages with question title

    On permalinks, all the page titles / SEO title / meta titles (choose your preferred name) default to 'Questions - PostHog'.

    This isn't ideal given we'll soon have quite a lot of these pages, all with identical titles. Google won't enjoy this.

    Solution: auto populate the title with the question title. I'd suggest we use the following logic:

    [Question Title] - PostHog Questions

    enhancement 
    opened by andyvan-ph 1
  • Improve Squeak! admin UI

    Improve Squeak! admin UI

    Updating to this email-style layout should reduce friction in handling questions in bulk by reducing the number of clicks and page loads.

    Also note I removed the "Resolved" checkbox since (I think?) this should really be done by selecting an answer, not closing a thread without selecting one.)

    2-column admin UI

    opened by corywatilo 1
  • add animated logo to login page

    add animated logo to login page

    note: currently broken due to:

    Error: Element type is invalid: expected a string (for built-in components) or a class/function (for composite components) but got: object.
    
    opened by corywatilo 1
  • Roadmap:

    Roadmap: "Under Consideration" is using GitHub title, "In Progress" is using Squeak! title

    If an issue is in the "Under Consideration" column on the roadmap, the title that is shown is the linked GitHub issue title.

    If an issue is in the "In Progress" column on the roadmap, the title that is shown is the Squeak! title.

    This logic wasn't clear to me and is not explained. I would expect if I give an issue a title in Squeak, that's what's being used for the roadmap as well.

    opened by annikaschmid 0
  • "Projected Completion Date” can't be removed for a roadmap item

    Steps to replicate:

    1. Open a roadmap item that has a "Projected completion date"
    2. Remove the projected completion date
    3. Click "Update Goal"

    When I reopen the roadmap item, the projected completion date is still set

    @joethreepwood could replicate this

    bug 
    opened by annikaschmid 0
  • Multitenancy

    Multitenancy

    We have an issue with multitenancy where, if you're a member of one community, you can't also have your own community with the same email address.

    Example:

    1. User signs up to posthog.com community as a member
    2. User tries to login/signup to Squeak! admin with same email

    This doesn't work because they're a member of the posthog.com community as a user.

    We need a way for people to use the same email for multiple communities.

    Considerations

    • When authing to Squeak! admin, a way to select a project you're an admin of. (I don't think you need to be able to login to Squeak! admin as only a user of someone else's community.)
    opened by corywatilo 0
  • Posted answer only appears after refresh

    Posted answer only appears after refresh

    Whenever I post an answer in the Squeak web app, the text box just disappear, and the answer never appears. There isn't even a spinner. The answer is always there after I refresh the page though.

    bug 
    opened by Twixes 0
Owner
PostHog
Open-source product analytics platform
PostHog
TikTokLive-Widget: A socket client/server program that exposes a widget with alerts (such as gifts, followers ...) for a specific user streaming on Tik Tok Live platform

TikTokLive-Widget: A socket client/server program that exposes a widget with alerts (such as gifts, followers ...) for a specific user streaming on Tik Tok Live platform

null 3 Dec 3, 2022
docs: Repository for OSS Docs

Kubeslice Documentation This project repository contains the documentation for Kubeslice. We are so glad that you want to contribute! Prerequisites To

kubeslice 26 Jan 3, 2023
Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

Svante Jonsson IT-Högskolan 3 May 18, 2022
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022
Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

null 14 Jan 3, 2023
JqTree - Tree widget for jQuery

jqTree JqTree is a tree widget. Read more in the documentation. Features Create a tree from JSON data Drag and drop Works on ie9+, firefox, chrome and

Marco Braak 1k Dec 22, 2022
Fintoc.js ES Module - Use the Fintoc widget as an ES module

Fintoc.js ES Module Use the Fintoc widget as an ES module. Installation Install using npm! (or your favourite package manager) # Using npm npm install

Fintoc 6 May 13, 2022
Matrix Moderation Widget for Mjolnir

A widget for moderating with mjolnir. Highly WIP. Use at your own risk!

Marcel 7 Jun 23, 2022
Table of contents Trilium widget for editable and readonly text notes.

Trilium-TocWidget Table of contents Trilium widget for editable and readonly text notes. Screenshot Features The ToC is live and automatically updated

Antonio Tejada 25 Dec 29, 2022
Find in note Trilium widget to replace the crappy ctrl+f search.

Trilium-FindWidget Find in note Trilium widget to replace the crappy ctrl+f search. Video sandbox.-.Trilium.Notes.2022-04-22.15-41-19_rescaled.mp4 Fea

Antonio Tejada 8 Nov 22, 2022
PoGOEvents is a Scriptable widget that displays current and upcoming Pokemon GO events.

PoGOEvents PoGOEvents is a Scriptable widget that displays current and upcoming Pokemon GO events. All event data is gathered from from ScrapedDuck, w

Anthony 33 Nov 12, 2022
Scriptable Widget which shows current news from tagesschau.de

tagesschau-widget for Scriptable Based on this reddit post of u/trbn_hck Unfortunately the Repositorie in his GitHub profile is no longer exist. Widge

Robinson 5 Sep 12, 2022
Touch enabled selectable plugin inspired by the jQuery UI widget.

Inspired by the jQuery UI Selectable plugin. Functionality and options are identical to the jQuery UI version with some additions and performance enha

Karl 135 Nov 24, 2022
jQuery UI widget for structured queries like "Contacts where Firstname starts with A and Birthday before 1/1/2000 and State in (CA, NY, FL)"...

Structured-Filter · Structured-Filter is a generic Web UI for building structured search or filter queries. With it you can build structured search co

Olivier Giulieri 238 Jan 6, 2023
jQuery UI widget for color picking (similar to the one in Microsoft Office 2010).

evol-colorpicker · evol-colorpicker is a web color picker which looks like the one in Microsoft Office 2010. It can be used inline or as a popup bound

Olivier Giulieri 285 Dec 14, 2022
Dynamic island style widget for displaying what you're recently played on Spotify.

Spotify Island Dynamic island style widget for displaying what you're recently played on Spotify. ?? Check the demo spotify-island.mov 1. Get Spotify

Nurçin 5 Nov 24, 2022
API to pull Github information with ui widget.

Github UI Widget Demos Ahmet ilhan Github Profile Card Ahmet ilhan Github Repositories Card Ahmet ilhan Github Selected Repo Commits Github UI Widget

Ahmet İlhan 4 Nov 25, 2022
This widget allows to conduct polls in Matrix rooms.

Matrix Poll This widget allows to conduct polls in Matrix rooms. But unlike MSC3381, it is designed for more complex scenarios, like polls with multip

Nordeck IT + Consulting GmbH 14 Dec 19, 2022
Exemplo de como deve ser implementação de nirvana do teste de contrato com Pact seguindo todas as práticas descritas em https://docs.pact.io/pact_nirvana

Exemplo de 'Nirvana' do teste de contrato Esse repositório exemplifica as melhores implementações de teste de contrato, atingindo o nirvana e tendo co

Paulo Gonçalves 66 Nov 28, 2022