Skip to content

README roadmap, GOOD_FIRST_ISSUES.md and CHANGELOG are out of date #31

Description

@adaumsilva

Description

Several docs still describe the v0.1.0 state:

Acceptance criteria

  • Roadmap table reflects reality (Done / Open / In progress) and links each row to its issue number
  • GOOD_FIRST_ISSUES.md becomes a short pointer: how to find issues (label:"good first issue" link), how to claim one, link to CONTRIBUTING.md. Detailed specs live only in .github/issues/*.md + GitHub
  • CHANGELOG.md formatting fixed
  • Docstring references updated to https://github.com/adaumsilva/RAG-framework/issues
  • examples/README.md links to the open integration issues

Files to touch

  • README.md
  • .github/GOOD_FIRST_ISSUES.md
  • CHANGELOG.md
  • examples/README.md
  • ragframework/document/loaders.py, ragframework/document/chunkers.py, ragframework/embeddings/random_embedder.py, ragframework/retriever/in_memory.py, ragframework/generator/echo_generator.py

Estimated effort: Small (< 2 hours)

No activity

Activity on this issue will appear here.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions