docs: fix README discrepancies and cleanup outdated docs#93
Conversation
- Delete `GITLAB_API_CONSOLIDATION_ANALYSIS.md` as its recommendations are implemented. - Add `LICENSE` file (MIT) and update `Cargo.toml`. - Update `README.md` to clarify command usage order. - Restore `CLAUDE.md` as symlink to `AGENTS.md`. Co-authored-by: myaple <10523487+myaple@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
Can you double check all the command line arguments and descriptions in the reader specifically? Are any outdated? |
I have double-checked all command line arguments and descriptions in |
- Delete `GITLAB_API_CONSOLIDATION_ANALYSIS.md` as its recommendations are implemented. - Add `LICENSE` file (MIT) and update `Cargo.toml`. - Update `README.md` to clarify command usage order. - Restore `CLAUDE.md` as symlink to `AGENTS.md`. Co-authored-by: myaple <10523487+myaple@users.noreply.github.com>
This PR addresses discrepancies in the documentation identified during a deep dive.
Changes:
GITLAB_API_CONSOLIDATION_ANALYSIS.md. This file contained a roadmap for refactoring the GitLab API client. A review ofsrc/gitlab.rsconfirmed that all proposed changes (consolidating search, issue fetching, note fetching, and label operations) have been implemented. The document was therefore outdated and misleading.README.mdand badges claim the project is MIT licensed, but the repository was missing aLICENSEfile and thelicensefield inCargo.toml. Added standard MIT License text toLICENSEand updatedCargo.toml.README.mdto clarify that slash commands must follow the bot mention (e.g.,@gitbot /plan) to be correctly parsed, as the parser expects the command to be in the text after the mention.CLAUDE.mdas a symbolic link toAGENTS.md, preserving the project structure.PR created automatically by Jules for task 8665293062200874617 started by @myaple