Skip to main content

SolidUI Community - Official Website Introduction

· 5 min read

Background​

With the rise of language models for generating images from text, SolidUI aims to help people quickly build visualization tools. The visualization content includes 2D, 3D, and 3D scenes, thus quickly constructing three-dimensional data demonstration scenes. SolidUI is an innovative project that aims to combine natural language processing (NLP) with computer graphics to achieve text-to-graphic functions. By building its own text-to-graphic language model, SolidUI uses the RLHF (Reinforcement Learning Human Feedback) process to implement the process from text description to graphic generation.

Project link: https://github.com/CloudOrc/SolidUI

Project mirror link: https://gitee.com/CloudOrc/SolidUI

Community official website: https://cloudorc.github.io/SolidUI-Website/

Official website project address：https://github.com/CloudOrc/SolidUI-Website

Introduction​

The SolidUI official website serves as a hub for users to access basic information and latest updates about SolidUI. The website is divided into several sections:

  • Document: This is where SolidUI's documentation is located, where users can find detailed product use guides and related materials, including user guides, development, deployment, operation, and test cases.
  • Download: Users can download the latest version of SolidUI here.
  • Releases: The release records of SolidUI can be found here, where users can view all version release and update information.
  • Community: This is the community page of SolidUI where users can participate in discussions, share experiences, or seek help.
  • Code of conduct: This is the code of conduct for the SolidUI community, providing an environment of mutual respect for community members.
  • Become A Committer: A page for developers to submit code or become project contributors.
  • Documentation Notice: Notices or updates about SolidUI's documentation.
  • Submit Code: A page for submitting code where users can submit their own code for the SolidUI project.
  • Team: Page introducing the SolidUI team members.
  • Users: A page showcasing SolidUI users or customers, thanking partners for their participation.
  • Our Users: A page likely introducing SolidUI's user groups.
  • Blog: The SolidUI blog, where users can read the latest articles about SolidUI. Official website: https://cloudorc.github.io/SolidUI-Website/

Official website project address：https://github.com/CloudOrc/SolidUI-Website

How to Contribute​

Based on the official website project address, you can submit Issues and PRs for joint construction, with PRs submitted to the dev branch.

Example​

For documentation contributions, both Chinese and English versions need to be submitted as the official website supports internationalization.

Submit an Issue

  1. First, visit the main page of the SolidUI-Website project.
  2. In the top menu bar of the project, click "Issues".
  3. Click the "New issue" button in the upper right corner.
  4. Enter the title and description of your Issue on the page that appears.
  5. When you're done, click "Submit new issue". Submit a Pull Request

Before submitting a Pull Request, you need to first fork the project and make changes on your branch. Here are the steps:

  1. On the main page of the SolidUI-Website project, click the "Fork" button in the upper right corner.
  2. In your forked version, select or create the branch you want to modify. In this case, you should select or create a "dev" branch.
  3. Make the required changes on your branch.
  4. When you have completed the changes and submitted them to your GitHub repository, return to the main page of the SolidUI-Website project.
  5. Click "Pull requests", then click "New pull request".
  6. Click "compare across forks" and choose your fork and your "dev" branch.
  7. Confirm your changes, then click "Create pull request".
  8. Provide a title and description for your PR on the opened page, then click "Create pull request".

Conclusion​

Please note that the SolidUI-Doc community documentation project is no longer maintained. Future documentation resources will be maintained on the official website project.

We've introduced the SolidUI official website and how to submit Issues and PRs on GitHub. SolidUI is an AI-generated visualization prototyping and editing platform that supports 2D, 3D models, and is combined with a Large Language Model (LLM) for quick editing.

Participating in SolidUI's development, you can contribute by submitting Issues and PRs. Issues are used to report bugs or propose new feature suggestions, while PRs are used to submit your own code changes. When submitting a PR, you should first create or select an appropriate development branch (such as the dev branch) in your forked repository, then make changes on that branch. After completing the changes, you can create a PR, requesting to merge your changes into the original project.

Whether you are a user of SolidUI or a developer hoping to contribute, we welcome you to submit Issues and PRs on GitHub to jointly promote the development of SolidUI.

SolidUI-Website Contributors​

The release of the SolidUI-Website official website would not have been possible without the contributors of the SolidUI community. Thanks to all community contributors, including but not limited to the following Contributors (ranked in no particular order):

  • dlimeng
  • 15100399015
  • limingoo

Acknowledgments​

Thanks to the streampark-website for providing framework support.

How to Become a Contributor​

Here are some ways to contribute to the SolidUI community.

Contribute to Official Documentation: Discover deficiencies in the documentation, optimize the documentation, and continually update the documentation to contribute to the community. By contributing to the documentation, developers can familiarize themselves with how to submit PRs and truly participate in community building. Reference strategy: https://github.com/CloudOrc/SolidUI/discussions/54

Contribute Code: We have combed through simple and easy-to-start tasks in the community, which are very suitable for newcomers to contribute code. Please check the newcomer task list: https://github.com/CloudOrc/SolidUI/issues/12

Content Contribution: Publish content related to SolidUI open source components, including but not limited to installation and deployment tutorials, usage experience, case practices, etc. The form is not limited, please contribute to the assistant. For example: https://github.com/CloudOrc/SolidUI/issues/10

Community Q&A: Actively answer questions in the community, share technology, help developers solve problems, etc.

Others: Actively participate in community activities, become a community volunteer, help community publicity, provide effective suggestions for community development, etc.