Small updates on the readme file [3]

[lotif]

PR Type

Documentation

Short Description

Another batch of small updates on the readme file.

Tests Added

.

Summary by CodeRabbit

Documentation

• Updated the REST API endpoint path for the file evaluation feature to now properly include the required /api namespace prefix, ensuring consistency with standard API routing conventions and improving overall documentation clarity
• Added author attribution (Wallach et al.) to the referenced research paper citation within the documentation

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f4e2446b-c21e-4b2a-a46e-bdaddbba6edb

📥 Commits

Reviewing files that changed from the base of the PR and between f9a7ae4 and 8c42a36.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

Update the README.md documentation file with two changes: add author attribution "by Wallach et al." to a paper citation, and adjust the documented REST API endpoint path for the evaluate_from_file endpoint from http://localhost:8080/evaluate_from_file to http://localhost:8080/api/evaluate_from_file.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Small updates on the readme file [3]' is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific changes made.	Replace the generic phrasing with a specific summary of the main changes, such as 'Update README with API endpoint path and citation attribution' to clearly communicate the primary updates.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description follows the required template structure with PR Type and Short Description sections, though 'Tests Added: .' is incomplete; however, the overall structure is present and sufficient.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch marcelo/update-readme-3

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}