{
 "schema_version": 1,
 "generated": "2026-10-26",
 "id": "lmliheng-adelie--one-sentence-rag-docs-app",
 "repo": "lmliheng/Adelie",
 "repo_url": "https://github.com/lmliheng/Adelie",
 "repo_slug": "lmliheng-adelie",
 "title": "Turn a docs URL into a cited Q&A app",
 "page_title": "How to turn a docs URL into a cited Q&A app with Adelie",
 "summary": "Describe a docs-expert Q&A app in one sentence and get a runnable agent app.",
 "who": "A developer or team lead who needs an internal help bot over a public documentation repo and does not want to scaffold a RAG app by hand.",
 "problem": "Building a retrieval-augmented Q&A app from scratch means collecting sources, wiring retrieval, adding citations and writing run instructions.",
 "outcome": "Adelie produces the whole agent application (scaffold, code and run instructions) in one go, with retrieval-based answers that cite the source files.",
 "steps": [
  "Install the command line with `curl -fsSL https://github.com/lmliheng/Adelie/releases/latest/download/install.sh | sh` on Linux or macOS, or `npm install -g @adelie/cli` on any platform with Node 24 or newer.",
  "Run `penguin web` and open the first-login link the server prints, then set the password for the built-in admin account.",
  "On the Models page, add an API key for one model provider.",
  "Describe the app in one sentence, naming the docs URL and the expert persona, and ask for a RAG Q&A app with cited sources.",
  "Open the generated app, check that answers link back to the original files, and run it with the instructions Adelie returns."
 ],
 "agent_prompt": "Using the Adelie repo (lmliheng/Adelie), ask the local Adelie instance to build a RAG Q&A app over <docs URL> that answers as <persona> and cites source files. Expected output: a runnable app folder with run instructions. Verify that a sample answer includes a citation that opens the original file.",
 "agents": [
  "any"
 ],
 "difficulty": "Intermediate",
 "time": "1 hour",
 "basis": "readme",
 "caveat": "The Windows installer is not code-signed yet, so SmartScreen shows a warning on first run, and macOS has no build yet.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "typescript",
 "requirements": [
  "A computer running Windows 10+ (x64), Linux (x64), or macOS (arm64 or x64)",
  "Node 24 or newer if you use the npm or from-source install",
  "An API key from at least one supported model provider, entered on the Models page",
  "For browser tasks: credentials for the sites you want the agent to use, imported from your own browser"
 ],
 "risk": "sensitive",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [
  {
   "tag": "remote-script",
   "notice": "The Linux and macOS one-line installer is a curl pipe to sh, so read the script at its release URL first if your policy requires it."
  }
 ],
 "best": true,
 "score": 1.0,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/lmliheng-adelie/one-sentence-rag-docs-app/",
 "md": "https://dedupedai.com/use-cases/lmliheng-adelie/one-sentence-rag-docs-app/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/lmliheng-adelie--one-sentence-rag-docs-app.json",
 "api_version": "v1"
}