IDEAS

Help shape the future of CurseForge!

API for Updating Project Descriptions and Metadata

Summary

I propose the development and implementation of an API that allows developers to update project descriptions, wiki links, source links, issue links, and logos programmatically. This feature would significantly streamline the management of project pages, especially for developers who maintain multiple projects.

Benefits:

  1. Efficiency and Automation: By allowing updates through an API, developers can automate the process of synchronizing project descriptions and metadata across multiple platforms. For example, descriptions can be kept in sync with a specified file (like a README) on GitHub, reducing the manual effort required to update each project page individually.

  2. Consistency: Ensuring that all project descriptions are up-to-date and consistent across various platforms can be challenging. An API would simplify this task, making it easier to maintain accurate and current information.

  3. Improved Communication: Developers can use automated updates to provide real-time information on the status of projects, such as current features, ongoing development, and recent changes. This could include a "current news" section at the top of the description to keep users informed about the latest updates, like the progress of porting to a new Minecraft version.

  4. Enhanced User Experience: Users benefit from having the latest information readily available, which can improve their experience and engagement with the projects.


Use Case Example: A developer manages all project descriptions in a single GitHub repository. With each push, a GitHub workflow updates the descriptions on Modrinth using their existing API. However, the same functionality is not available for CurseForge, resulting in outdated or inconsistent information. An API for updating descriptions and metadata on CurseForge would solve this problem by allowing the same automation.


Community Demand: Many developers, myself included, find it cumbersome to manually update project pages. The introduction of such an API would be welcomed by those who manage multiple projects and seek to provide their users with the most current information.


Conclusion: Implementing an API for updating project descriptions, wiki links, source links, issue links, and logos would be a valuable addition to the platform. It would save developers time, ensure consistency, and improve the overall user experience. I strongly urge the consideration of this feature in future updates.

  • MelanX
  • Jun 26 2024
  • Future consideration
  • Attach files

Hold on!
Before you post your idea…

for game or mod suggestions go to our discord

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

  6. Please post 1 idea per post

    Posts with multiple ideas can not be merged and prevent us from opening these posts for upvotes