Combine changelogs and more elaborate changelog creation

Add a way to see multiple changelogs at once so it is easier to see what changed when we did not update for a long time. A way to do this would maybe to add a more elaborate changelog creation screen with an summary/important tab, in depth change logs, etc so the multiple changelogs would only show all summaries and not in depths changes.

  • Guest
  • Aug 28 2024
  • Future consideration
  • Attach files
  • Guest commented
    15 Apr 11:43

    That's a great idea! Providing a way to view consolidated summaries of multiple changelogs would significantly improve the experience for users who haven't updated in a while. Here's a breakdown of how this could be implemented, focusing on the user interface and underlying data structure:

    Conceptual Implementation: The Toll Roads

    1. Changelog Data Structure:

      • Each version release would have its own changelog file or database entry.

      • Within each changelog, you'd need to structure the information to differentiate between a concise summary and detailed changes. A possible structure could be:

      JSON

      {
      "version": "1.5.0",
      "release_date": "2025-04-10",
      "summary": "Major feature update with enhanced collaboration tools and performance improvements.",
      "important": [
      "Introduced real-time co-editing functionality.",
      "Significantly improved loading speeds for large projects.",
      "Updated user interface for better navigation."
      ],
      "details": {
      "new_features": [
      "Added a new commenting system with threaded discussions.",
      "Implemented shared project workspaces.",
      "Introduced version history for individual files."
      ],
      "bug_fixes": [
      "Fixed an issue where exporting to PDF would sometimes fail.",
      "Resolved a bug causing incorrect display of date formats.",
      "Addressed security vulnerabilities related to user authentication."
      ],
      "performance_improvements": [
      "Optimized database queries for faster data retrieval.",
      "Reduced memory consumption during large file processing."
      ]
      }
      }
    2. Changelog Creation Screen (Enhanced):

      • When creating a new changelog, the interface should provide separate fields or sections for:

        • Version Number: (e.g., 1.5.0)

        • Release Date:

        • Summary: A brief, one or two-sentence overview of the key changes.

        • Important Highlights: A bulleted list of the most significant changes or features that users should be aware of immediately.

        • Detailed Changes: Sections for specific categories like "New Features," "Bug Fixes," "Performance Improvements," "Security Updates," etc., with more in-depth descriptions.

    3. Multiple Changelog Viewing Interface:

      • Option 1: Dedicated "View Multiple Changelogs" Screen:

        • Users could navigate to a new section in the application settings or help menu.

        • They would be presented with a list of available versions (or a range selection).

        • Upon selecting a range or multiple versions, the screen would display a consolidated view.

        • This consolidated view would primarily show the "Summary" and "Important Highlights" from each selected changelog.

        • There could be an option to expand a specific version's entry to view its "Details" if the user wants more information.

      • Option 2: Integrated into the Existing Changelog View:

        • The existing changelog view could be enhanced with options to:

          • "View Changes Since Last Update": Automatically selects all versions released since the user's last recorded update.

          • "Select Versions to Compare": Allows manual selection of multiple versions.

        • The display would then present the consolidated summaries and highlights.

    User Interface Considerations:

    • Clear Visual Distinction: Use headings, separators, and potentially different styling to clearly delineate the changelogs for different versions.

    • Concise Presentation: Focus on the "Summary" and "Important Highlights" to avoid overwhelming the user with too much information.

    • Expand/Collapse Functionality: Allow users to expand a specific version's entry to see the detailed changes if needed.

    • Filtering/Sorting (Optional): For applications with a long history of updates, consider allowing users to filter by date range or sort by version number.

    • User Feedback: Provide a way for users to give feedback on the usefulness and clarity of this multi-changelog view.

    Benefits of this Approach:

    • Easy Catch-Up: Users who have skipped several updates can quickly understand the major changes without having to read through numerous individual changelogs.

    • Improved Awareness: Highlights the most important updates, ensuring users don't miss critical new features or bug fixes.

    • Reduced Information Overload: Presents a more digestible overview of changes.

    • Better User Experience: Makes the update process less daunting and more informative.

    Technical Considerations:

    • Data Storage: Decide on the best way to store changelog data (e.g., individual markdown files, JSON files, database entries).

    • Parsing and Processing: Implement logic to read and parse the changelog data to extract the summary, important highlights, and details.

    • UI Development: Build the user interface components to display the consolidated information effectively.

    By implementing a well-structured changelog creation process and a user-friendly interface for viewing multiple changelogs, you can significantly improve the update experience for your users, especially those who haven't updated in a while.

Hold on!

Before you post your idea…

This board is being moderated, if you wish for your idea(s) to go public, please consider the following:

  1. Search for existing ideas

    If your idea already exists, vote for it, this will increase the chances for the idea to become reality. Duplicate ideas only split and lower votes

  2. No tech-support

    This board is for new ideas and feature suggestions, for technical issues or bug reports, visit/contact CurseForge Support

  3. English only

    This ensures that the idea is accessible to a wider audience and makes it easier for others to understand and vote for the idea

  4. No profanity

    Any ideas posted with foul language will not be published and get deleted

  5. Stay on point

    Avoid posting 'lists' of different ideas, we won't be able to address them with a proper status and they will get less votes from others, each idea should have its own post