Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update quicktasklink.md #310

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

rogercreagh
Copy link
Contributor

@rogercreagh rogercreagh commented Sep 11, 2024

User description

Correct spelling typo in "Quicktask link" sub -head

Changed Quicktask link section text to refer to title which appears as a mouseover the icon, and to state that the language string needs to be in the .sys.ini lanuage file

Added new sub-section Quicktask Icon with explanation and example.

Added fontawesome icon example to the Example section

NB there is also a tag but I can find no information how to use it.


PR Type

documentation


Description

  • Corrected spelling errors in the "Quicktask Link" section headers.
  • Expanded documentation to include details on specifying Quicktask titles and icons.
  • Added a new subsection explaining how to use Quicktask Icons, including examples with FontAwesome.
  • Clarified that the title translation string must be included in the language .sys.ini file.

Changes walkthrough 📝

Relevant files
Documentation
quicktasklink.md
Update Quicktask Link Documentation with Icons and Titles

versioned_docs/version-5.1/building-extensions/components/quicktasklink.md

  • Corrected spelling errors in section headers.
  • Added explanation for Quicktask title and icon.
  • Included examples for specifying icons, including FontAwesome.
  • Clarified the need for language strings in .sys.ini files.
  • +24/-4   

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

    Correct spelling typo in "Quicktask link" sub -head
    
    Changed Quicktask link section text to refer to title which appears as a mouseover the icon, and to state that the language string needs to be in the .sys.ini lanuage file
    
    Added new sub-section Quicktask Icon with explanation and example.
    
    Added fontawesome icon example to the Example section
    
    NB there is also a <quicktask-permission> tag but I can find no information how to use it.
    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 2 labels Sep 11, 2024
    Copy link
    Contributor

    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: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review

    Copy link
    Contributor

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

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Typo
    Fix a spelling error in the explanation of where the menu link is added

    Correct the spelling of "manifest" in the sentence explaining where the menu link is
    added during installation.

    versioned_docs/version-5.1/building-extensions/components/quicktasklink.md [17]

    -Your menu link is added in the manfest file during installation.
    +Your menu link is added in the manifest file during installation.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: The suggestion correctly identifies and fixes a spelling error in the word "manifest," improving the clarity and professionalism of the documentation.

    9
    Fix a spelling error in the explanation of default icon usage

    Correct the spelling of "components" in the sentence explaining the default icon
    usage.

    versioned_docs/version-5.1/building-extensions/components/quicktasklink.md [37]

    -The default icon is the '+' sign indicating create a new item as this is the most common usage in the built-in compponents.
    +The default icon is the '+' sign indicating create a new item as this is the most common usage in the built-in components.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: The suggestion correctly identifies and corrects a spelling mistake in the word "components," enhancing the readability and correctness of the documentation.

    9
    Correct the spelling in the XML code block title for consistency

    Correct the spelling of "Quicktask" in the XML code block title to maintain
    consistency with the rest of the document.

    versioned_docs/version-5.1/building-extensions/components/quicktasklink.md [23]

    -```xml title="Qicktask Link and title"
    +```xml title="Quicktask Link and title"
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: The suggestion addresses a spelling error in the XML code block title, ensuring consistency and accuracy throughout the document.

    8

    @HLeithner
    Copy link
    Member

    That change needs to be done in /docs (and additional in versioned-docs) but /docs is the important version for such changes

    @rogercreagh
    Copy link
    Contributor Author

    That change needs to be done in /docs (and additional in versioned-docs) but /docs is the important version for such changes

    So does that require a separate PR - I assumed if I just edit from the published page it would update all copies which would be sensible?

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants