modalselect documented, js library folder, small fixes

robbiejackson commented 2 months ago

User description

ModalSelectField documented for 5.2

Also I moved the javascript entries into a subfolder Joomla Javascript library. This is to make way for documents covering how to use js in your extensions, ajax, json response, maybe more.

A couple of fixes in the exampleform component url.

Plus documented icons section

PR Type

documentation, enhancement

Description

Added comprehensive documentation for the ModalSelect field, including examples and implementation details.
Corrected URL paths in multiple documentation files to ensure consistency and accuracy.
Added new documentation sections for Joomla JavaScript Library and icons usage.
Removed outdated JavaScript overview document.
Fixed typos and corrected paths to related documentation for better clarity.

Changes walkthrough 📝

Relevant files

Documentation

13 files

example-form-component.md `Correct URL path in example component documentation` docs/building-extensions/components/example-form-component.md Corrected URL path for running the example component. Updated documentation for consistency.	+2/-2
step9-ajax.md `Update path to core.js documentation` docs/building-extensions/modules/module-development-tutorial/step9-ajax.md - Updated the path to the core.js documentation.	+1/-1
modalselect.md `Add documentation for ModalSelect field` docs/general-concepts/forms-fields/standard-fields/modalselect.md Added comprehensive documentation for the ModalSelect field. Included examples and implementation details.	+221/-0
icons.md `Add documentation for Joomla icons usage` docs/general-concepts/icons.md Added documentation for using icons in Joomla. Explained usage of FontAwesome icons.	+29/-0
index.md `Remove outdated JavaScript overview document` docs/general-concepts/javascript/index.md - Removed outdated JavaScript overview document.	+0/-4
core.md `Correct path to WebAssetManager documentation` docs/general-concepts/javascript/js-library/core.md - Corrected path to WebAssetManager documentation.	+1/-1
editors.md `Correct path to WebAssetManager documentation` docs/general-concepts/javascript/js-library/editors.md - Corrected path to WebAssetManager documentation.	+1/-1
index.md `Add Joomla JavaScript Library section` docs/general-concepts/javascript/js-library/index.md - Added a new section for Joomla JavaScript Library.	+6/-0
joomla-dialog.md `Correct path to WebAssetManager documentation` docs/general-concepts/javascript/js-library/joomla-dialog.md - Corrected path to WebAssetManager documentation.	+1/-1
modal-content-select.md `Fix typo in dialog buttons recommendation` docs/general-concepts/javascript/js-library/modal-content-select.md - Fixed a typo in the recommendation for dialog buttons.	+1/-1
example-form-component.md `Correct URL path in example component documentation` versioned_docs/version-4.4/building-extensions/components/example-form-component.md - Corrected URL path for running the example component.	+2/-2
example-form-component.md `Correct URL path in example component documentation` versioned_docs/version-5.0/building-extensions/components/example-form-component.md - Corrected URL path for running the example component.	+2/-2
example-form-component.md `Correct URL path in example component documentation` versioned_docs/version-5.1/building-extensions/components/example-form-component.md - Corrected URL path for running the example component.	+2/-2

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

codiumai-pr-agent-pro[bot] commented 2 months ago

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review

Documentation Clarity
The newly added documentation for ModalSelect field is comprehensive but could benefit from a brief overview or summary at the beginning to help readers quickly grasp the concept before diving into details. Typo
There's a typo in the word "interactive" which is spelled as "intercative" in the old hunk. This has been corrected in the new hunk, but it's worth noting for overall quality assurance.

codiumai-pr-agent-pro[bot] commented 2 months ago

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Correct relative path in documentation link ___ Update the relative path in the link to the WebAssetManager documentation to ensure it correctly points to the intended location. [docs/general-concepts/javascript/js-library/core.md [6]](https://github.com/joomla/Manual/pull/302/files#diff-9315a7ade5625b32a1f1992ae934402ee52159cb87d3ed7db6c557781b55f5ecR6-R6) ```diff -To enable it on the page use [WebAssetManager](../../web-asset-manager.md) `$wa->useScript('core')`. +To enable it on the page use [WebAssetManager](../../../general-concepts/web-asset-manager.md) `$wa->useScript('core')`. ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 10 Why: The suggestion accurately corrects the relative path in the documentation link, ensuring it points to the correct location, which is crucial for user navigation.	10
Enhancement	Correct spelling error in documentation text ___ Correct the spelling of "interactive" in the sentence to improve readability and professionalism. [docs/general-concepts/javascript/js-library/modal-content-select.md [40]](https://github.com/joomla/Manual/pull/302/files#diff-7ae7519c9bb59df4ca7600889381ae2c72f27d66bed23849ebbbb2f6199a5db2R40-R40) ```diff +It is recommended that all interactive buttons (like `save`, `cancel` etc) be embedded within dialog content (within iframe), instead of rendering them with parent window. - ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies and fixes a spelling error, improving the readability and professionalism of the documentation.	9

joomla / Manual