Skip to content

Introduce new About section and restructure the menu #457

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

Merged
merged 5 commits into from
May 5, 2025

Conversation

HLeithner
Copy link
Member

@HLeithner HLeithner commented May 4, 2025

User description

Also remove duplicated content from the readme.
Beside active the 53-54 migration entry and some small changes.


PR Type

Enhancement, Documentation


Description

  • Introduce a new About section with dedicated sidebar and menu entry

    • Adds about folder with documentation and sidebar config
    • Moves About content out of main docs
  • Restructure and improve the main navigation menu

    • Adds About and Migrations as top-level items
    • Adjusts API/Framework/Using the CMS menu positions
    • Improves docs version dropdown
  • Remove duplicated and outdated content from README

    • README now points contributors to About section
  • Activate and update 5.3-5.4 migration documentation

    • Adds migration index and improves compatibility plugin doc

Changes walkthrough 📝

Relevant files
Enhancement
2 files
docusaurus.config.js
Add About docs plugin and restructure navbar/menu               
+49/-22 
sidebarsAbout.js
Add sidebar configuration for About section                           
+20/-0   
Documentation
9 files
README.md
Remove duplicated docs, point to About section                     
+4/-188 
documentation.md
Add and expand contributor documentation in About               
+65/-21 
index.md
Add About section landing page (placeholder)                         
+6/-0     
versioning.md
Add documentation versioning guide to About                           
[link]   
index.md
Remove About page from main docs (moved)                                 
+0/-10   
changes.md
Update sidebar position and heading for clarity                   
+3/-3     
compat-plugin.md
Improve compatibility plugin doc and formatting                   
+9/-3     
index.md
Add migration index for 5.3 to 5.4                                             
[link]   
index.md
Rewrite migration docs intro for clarity and accuracy       
+11/-13 

Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Also remove duplicated content from the readme. Beside active the 53-54 migration entry and some small changes.
    Copy link
    Contributor

    qodo-merge-pro bot commented May 4, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Menu Positioning

    The PR moves API and Framework links from left to right position, but doesn't update all position attributes consistently. Some menu items have position attributes while others don't have them explicitly defined.

    {
      href: 'https://api.joomla.org',
      label: 'API',
      position: 'right',
    },
    {
      href: 'https://framework.joomla.org',
      label: 'Framework',
      position: 'right',
    },
    Example Version

    The versioning example uses 4.3.0 which may be outdated. Consider updating to a more recent version number that matches the current documentation context.

    npm run docusaurus docs:version 4.3.0
    
    </details>
    
    </td></tr>
    </table>
    

    Copy link
    Contributor

    qodo-merge-pro bot commented May 4, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Fix typo in documentation
    Suggestion Impact:The commit fixed the typo 'githut' to 'GitHub' as suggested, and also fixed the same typo in other places throughout the document

    code diff:

    -forked copy in your githut repository into this git instance. 
    +forked copy in your GitHub repository into this git instance. 

    There's a typo in the word "githut" which should be "GitHub". This typo appears
    in the documentation about contributing to the project and could confuse new
    contributors.

    about/documentation.md [20-21]

     To install Docusaurus on your own machine you should initialise a local git repository and clone the manual from the
    -forked copy in your githut repository into this git instance.
    +forked copy in your GitHub repository into this git instance.

    [Suggestion has been applied]

    Suggestion importance[1-10]: 3

    __

    Why: The suggestion correctly identifies and fixes a typo ('githut' instead of 'GitHub') in the documentation file (about/documentation.md). This improves the clarity and professionalism of the text.

    Low
    • Update

    @HLeithner HLeithner merged commit 937c8dd into joomla:main May 5, 2025
    2 checks passed
    @HLeithner HLeithner deleted the feature/restructure-menu branch May 5, 2025 05:50
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant