docs: fix getting started guide formatting - #87
Merged
adaumsilva merged 2 commits intoOct 3, 2026
Merged
Conversation
Contributor
Author
|
Hi, the PR is ready for review. The GitHub Actions workflows are currently awaiting maintainer approval. Please approve the workflows when convenient so the required checks can run. Thank you! |
Owner
|
Good job @karthik-kumarux ! Thanks for the contribution. Remember to star the repo if you didn't yet. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fix the formatting and readability issues in
docs/getting-started.mddescribed in Issue #30.The guide was rendered incorrectly because of escaped Markdown headings, HTML entities, escaped underscores, excessive blank-line spacing, and malformed code formatting. The examples were checked against the current repository API.
Closes #30
Changes
docs/getting-started.md.README.mdandCONTRIBUTING.md.[Unreleased]inCHANGELOG.md.Type of change
Checklist
pytest tests/ -vpasses locallyruff check ragframework/passesmypy ragframework/passesCHANGELOG.mdupdated under[Unreleased]