OpenFn / OpenFn/docs

Add developer surveys to key pages

Open
#642 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

We are currently developing a series of developer surveys aimed at getting feedback about various tools, like the CLI.

I expect we'll want surveys for the CLI, VSCode, and at least one for Lightning.

We should add a link to these surveys on particular pages of the docsite.

We could embed it as a tip or info boxout at the top of some docs pages:

Image

Or we could make it a banner at the top of the page (but within the contents). Maybe make it dismissable too.

Image

Maybe we can use Posthog, if we can target it to certain pages and make it not too annoying?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, survey URLs, or target pages. Start by locating the docsite's page-selection and notification components, then check whether PostHog or similar integration already exists. Confirm the CLI, VSCode, and Lightning survey links and pages with maintainers; done means the agreed surveys appear in the agreed locations without being overly intrusive.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.