Skip to content

docs: Add FAQ section with common questions and answers#121

Open
meichuanyi wants to merge 1 commit into
promptslab:mainfrom
meichuanyi:add-faq-section
Open

docs: Add FAQ section with common questions and answers#121
meichuanyi wants to merge 1 commit into
promptslab:mainfrom
meichuanyi:add-faq-section

Conversation

@meichuanyi
Copy link
Copy Markdown

Summary

This PR adds a comprehensive FAQ section to the README, addressing common questions users may have when using Promptify.

Changes

Added FAQ section covering:

  • How to set up API keys for different LLM providers (OpenAI, Anthropic, Google, Ollama)
  • How to add few-shot examples to improve accuracy
  • What happens when providers don't support structured outputs (safe fallback parser)
  • How to track API costs using
  • How to use Azure OpenAI with the prefix

Why

The README previously lacked a FAQ section, which is valuable for:

  • New users getting started
  • Common troubleshooting scenarios
  • Quick reference for frequently asked questions

Testing

  • Verified FAQ content matches existing documentation patterns
  • All code examples are consistent with Quick Tour section
  • FAQ positioned appropriately in document structure (after Supported NLP Tasks, before Community)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant