{"id":20446349,"url":"https://github.com/ray-project/docu-mentor","last_synced_at":"2025-04-13T00:45:25.733Z","repository":{"id":193243272,"uuid":"688407982","full_name":"ray-project/docu-mentor","owner":"ray-project","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-02T20:52:46.000Z","size":94,"stargazers_count":10,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T18:51:57.158Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ray-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-07T09:34:23.000Z","updated_at":"2024-05-27T14:01:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"f2b16c74-a0b2-40da-b6c4-261cdea137be","html_url":"https://github.com/ray-project/docu-mentor","commit_stats":null,"previous_names":["maxpumperla/docu-mentor","ray-project/docu-mentor"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ray-project%2Fdocu-mentor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ray-project%2Fdocu-mentor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ray-project%2Fdocu-mentor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ray-project%2Fdocu-mentor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ray-project","download_url":"https://codeload.github.com/ray-project/docu-mentor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650420,"owners_count":21139672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T10:19:36.274Z","updated_at":"2025-04-13T00:45:25.713Z","avatar_url":"https://github.com/ray-project.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docu-Mentor\n\n\u003cimg width=\"212\" alt=\"docu_mentor\" src=\"https://github.com/maxpumperla/docu-mentor/assets/3462566/de9f387a-4c97-4ade-a811-3b6282950f2c\"\u003e\n\nAutomatically get suggestions to improve the writing in your PRs from this\nGitHub app powered by [Anyscale Endpoints](https://app.endpoints.anyscale.com/).\n\n## Installation\n\nSimply install the app on your project on GitHub: [Docu-Mentor App](https://github.com/apps/docu-mentor)\n\n## Usage\n\nThen in any PR in your project, create a new comment that says:\n\n```bash\n@docu-mentor run\n```\n\nand I will start my analysis. I only look at what you changed\nin this PR. If you only want me to look at specific files or folders,\nyou can specify them like this:\n\n```bash\n@docu-mentor run doc/ README.md\n```\n\nIn this example, I'll have a look at all files contained in the\n\"doc/\" folder and the file \"README.md\".\n\n## Checking that it works\n\nSimply run\n\n```bash\npytest . -s\n```\n\nto evaluate the doc sanitation bot against GPT-4.\n\n## Deployment\n\nThe bot is built for deployment with [Anyscale Services](https://anyscale.com),\nusing the `service.yaml` with the `main.py` entrypoint provided in this repo.\nYou can also deploy it on Heroku, using the `Procfile` and `heroku.py`.\nWith Anyscale you can parallelize your bot using Ray, reducing the total\nwallclock time, with Heroku that doesn't work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fray-project%2Fdocu-mentor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fray-project%2Fdocu-mentor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fray-project%2Fdocu-mentor/lists"}