Skip to content

README suggestion: add a “choose your path” onboarding section #2790

Description

@YANGCHUNHONG3000

🎯 Problem Statement

New visitors may need help choosing the right entry point. QVAC covers many capabilities (LLMs, speech, translation, OCR, image generation, RAG, P2P, CLI, SDK), so the README can feel broad before a reader knows which path to follow.

The README already has a strong quickstart and useful detail, but a decision-oriented section near the top could help developers answer: “Where should I start for my use case?”

💡 Proposed Solution

Add a short “Choose your path” section before Usage. Example:

## Choose your path
| Goal | Start here |
| --- | --- |
| Run a local LLM | Quickstart |
| Use OpenAI-compatible API | CLI / HTTP server docs |
| Build P2P inference | P2P capabilities |
| Add speech / OCR / translation | Capability packages |

Also consider adding expected output after the Quickstart. A short example of what success looks like after running node quickstart.js would reduce uncertainty for first-time users.

Finally, the long capability list could be easier to scan as a shorter overview table like “Capability / When to use it,” with details below.

📋 Use Cases

  1. New developers evaluating whether QVAC fits their local AI use case.
  2. Developers who want OpenAI-compatible local inference but do not know whether to start with the CLI, HTTP server, or SDK.
  3. Builders interested in P2P inference who need a clearer entry point from the README.

📊 Expected Impact

Critical - Enables major functionality currently impossible

🔄 Alternatives Considered

  • Keep current structure: works for readers who already know what they want, but new visitors still need to scan a lot.
  • Move all guidance to external docs: useful long-term, but a small README routing table would help discovery immediately.
  • Do nothing: the README remains accurate, but less decision-oriented for first-time evaluators.

⚠️ Constraints & Considerations

Documentation-only suggestion. No SDK API changes required. Should be compatible with the current README and docs structure.

🤝 Contribution

  • I would be willing to submit a PR for this feature

📎 Additional Context

No pressure — just a README/onboarding suggestion. QVAC has a lot of surface area, so a decision-oriented section near the top could help more developers find the right entry point quickly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions