GH-197 Remake outdated EternalCombat documentation. #197
Conversation
…th updated commands, configuration, and API guides - Removed legacy `features.mdx` and `using-api.mdx` files. - Added new `commands.mdx`, `api.mdx`, and `configuration.mdx` with comprehensive and modularized content. - Streamlined documentation layout for better readability and navigation.
✅ Deploy Preview for eternalcodeteam-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
vLuckyyy
changed the title
Summary of ChangesHello @vLuckyyy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly overhauls the EternalCombat plugin's documentation. It replaces legacy, outdated guides with a set of new, modular, and comprehensive pages covering API usage, commands, configuration, region management, and troubleshooting. The changes aim to provide developers and server administrators with up-to-date and easily navigable resources for integrating, configuring, and maintaining the plugin. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request is a major and welcome overhaul of the documentation. It replaces outdated pages with new, well-structured, and detailed guides for installation, configuration, commands, API usage, and more. The new documentation is much clearer and more user-friendly. My review includes a few suggestions to further improve clarity, mainly by ensuring code examples in the API documentation are complete and by clarifying the structure of YAML examples in the configuration guide. Overall, this is an excellent update.
…tion - Updated all heading levels to maintain consistent hierarchy across API, troubleshooting, commands, regions, configuration, and introduction guides. - Improved readability and accessibility by aligning sections with a modular structure.
vLuckyyy
changed the title
vLuckyyy
changed the title
|
@gemini-code-assist In troubleshooting.mdx correct all titles, subtitles and texts that have wrong case of letters and use proper english. Example: |
|
Thank you for the feedback, @CitralFlo! I understand you'd like to see corrections to the casing and phrasing in As an AI, I am unable to directly modify files or commit changes to the pull request. My role is to provide review comments and code suggestions. If you would like me to review |
Please do it. Create review with suggestions for this file in this PR. |
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request is a major overhaul of the EternalCombat documentation. The old documentation has been replaced with a much more detailed, structured, and user-friendly set of pages covering installation, configuration, commands, API usage, and more. The new documentation is well-written and uses modern components for a better reading experience. I've found a couple of minor inconsistencies in the configuration examples and troubleshooting guide that could be confusing for users. My specific comments address these points. Overall, this is an excellent and much-needed update.
CitralFlo
left a comment
CitralFlo
left a comment
There was a problem hiding this comment.
Change title and subtitle to have correct language and cases.
Example: "Commands Still Work During Combat" -> "Commands can be used during combat"
|
Also lacking placeholders section from EternalCombat.
And permissions:
|
…uides - Updated all section and subsection headings to follow consistent sentence-case capitalization for improved clarity and uniformity. - Adjusted JSON formatting in `biome.json` for better readability.
Co-authored-by: Michał Wojtas <80779749+CitralFlo@users.noreply.github.com>
Co-authored-by: Michał Wojtas <80779749+CitralFlo@users.noreply.github.com>
Co-authored-by: Michał Wojtas <80779749+CitralFlo@users.noreply.github.com>
…le guide - Consolidated `commands.mdx` into `commands-and-placeholders.mdx` for streamlined documentation. - Added PlaceholderAPI details and examples. - Improved formatting and readability throughout.
- Updated tab labels from "Gradle (Kotlin)" to "Gradle.kts" and "Gradle (Groovy)" to "Gradle" for uniformity.
Jakubk15
changed the title
No description provided.