Description
docs/getting-started.md appears to have been exported from a rich-text editor. On GitHub it renders as one unformatted blob:
- Every heading is escaped:
\# Getting Started, \## Installation, \### Requirements (29 occurrences)
- Indentation inside code blocks is written as
  HTML entities
- Underscores are escaped:
chunk\_size, top\_k
- 322 of the 480 lines are blank (every paragraph is separated by 3 empty lines)
- File uses CRLF line endings (see the
.gitattributes issue)
Motivation
This is the first document a new contributor or user opens after the README. Right now it is unreadable, which undermines the whole onboarding story.
Acceptance criteria
Files to touch
docs/getting-started.md
README.md — add a link under Quick Start
CONTRIBUTING.md — add a link
Resources
README.md Quick Start and examples/basic_rag.py as the source of truth for working code
Estimated effort: Small (< 2 hours)
Description
docs/getting-started.mdappears to have been exported from a rich-text editor. On GitHub it renders as one unformatted blob:\# Getting Started,\## Installation,\### Requirements(29 occurrences) HTML entitieschunk\_size,top\_k.gitattributesissue)Motivation
This is the first document a new contributor or user opens after the README. Right now it is unreadable, which undermines the whole onboarding story.
Acceptance criteria
\#headings converted to real Markdown headings with a sensible hierarchy (#→##→###) and\_escapes removed; code samples are inside fenced```pythonblocks and actually run against the current APIPDFLoader,RecursiveChunker,HuggingFaceEmbedder,FAISSRetriever,ChromaRetrieverwhere relevantREADME.md(it currently is not) and fromCONTRIBUTING.mdFiles to touch
docs/getting-started.mdREADME.md— add a link under Quick StartCONTRIBUTING.md— add a linkResources
README.mdQuick Start andexamples/basic_rag.pyas the source of truth for working codeEstimated effort: Small (< 2 hours)