OpenFn / OpenFn/apollo

Docsite Search: include FAQ

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

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

Nice idea from Taylor today

We could analyse the questions asked by users and hand-write a nice FAQ page on the docsite

Then, when running RAG, we could make sure to include this FAQ in the search (and perhaps bump the priority/weight of it). This could be a really good way to find tune the model's responses

Contributor guide

Open the contributing guide

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

No files, tests, or entry points are named. Start by clarifying how the proposed FAQ would be authored on the docsite and how RAG search should include or prioritize it. Done should mean the FAQ is available to search and its effect on model responses or ranking is validated.

Written by the indexing model from the issue text.

Assessment

Domain
ai, documentation, search
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.