背景
随着文本生成图像的语言模型兴起,SolidUI想帮人们快速构建可视化工具,可视化内容包括2D,3D,3D场景,从而快速构三维数据演示场景。SolidUI 是一个创新的项目,旨在将自然语言处理(NLP)与计算机图形学相结合,实现文生图功能。通过构建自研的文生图语言模型,SolidUI 利用 RLHF (Reinforcement Learning Human Feedback) 流程实现从文本描述到图形生成的过程。
项目地址: https://github.com/CloudOrc/SolidUI
项目镜像地址: https://gitee.com/CloudOrc/SolidUI
社区官网: https://website.solidui.top
官网项目地址:https://github.com/CloudOrc/SolidUI-Website
官网介绍
- 首页:用户可以获取关于SolidUI的基本信息和最新更新。
- Document:这是SolidUI的文档部分,用户可以在这里查找详细的产品使用指南和相关资料,分为用户指南,开发,部署,操作,测试用例。
- Download:用户可以在此下载SolidUI的最新版本。
- Releases:这是SolidUI的发布记录,用户可以在这里查看所有的版本发布和更新信息。
- Community:这是SolidUI的社区页面,用户可以参与讨论,分享经验,或者寻求帮助。
- Code of conduct:这是SolidUI社区的行为准则,为社区成员提供了一种相互尊重的环境。
- Become A Committer:一个供开发者提交代码或成为项目贡献者的页面。
- Documentation Notice:关于SolidUI文档的通知或更新。
- Submit Code:这是一个提交代码的页面,用户可以在这里为SolidUI项目提交自己的代码。
- Team:介绍SolidUI团队成员的页面。
- Users:展示SolidUI用户或客户的页面,感谢共建参与伙伴。
- Our Users:这可能是介绍SolidUI的用户群体的页面。
- Blog:这是SolidUI的博客,用户可以在这里阅读有关SolidUI的最新文章。
- ASF:这可能是链接到Apache Software Foundation的页面
- Foundation:关于Apache基金会的信息。
- License:这是SolidUI的许可信息。
- GitHub:这可能是链接到SolidUI的GitHub仓库。
- English:用户可以在这里切换网站的语言。网站提供的语言包括英文和简体中文。
- 社区官网: https://website.solidui.top
- 官网项目地址:https://github.com/CloudOrc/SolidUI-Website
官网项目贡献
https://github.com/CloudOrc/SolidUI-Website 基于官网项目地址,提交Issue和PR参与共建,PR提交dev分支。
举例
贡献文档,需要提交中文版本和英文版本,官网支持国际化。
提交Issue
- 首先,访问 SolidUI-Website 项目的主页。
- 在项目的顶部菜单栏中,点击 "Issues"。
- 点击右上角的 "New issue" 按钮。
- 在出现的页面中输入你的Issue的标题和描述。
- 当你完成后,点击 "Submit new issue"。
提交Pull Request
- 在提交Pull Request前,你需要先fork项目并在你的分支上做出更改。以下是步骤:
- 在 SolidUI-Website 项目的主页,点击右上角的 "Fork" 按钮。
- 在你的fork版本中,选择或创建你想要修改的分支。在这种情况下,你应该选择或创建一个 "dev" 分支。
- 在你的分支上进行所需的修改。
- 当你完成修改并提交到你的GitHub仓库后,返回到 SolidUI-Website 项目的主页。
- 点击 "Pull requests",然后点击 "New pull request"。
- 点击 "compare across forks" 并选择你的fork和你的 "dev" 分支。
- 确认你的更改,然后点击 "Create pull request"。
- 在打开的页面中,提供你的PR的标题和描述,然后点击 "Create pull request"。
结语
https://github.com/CloudOrc/SolidUI-Doc 社区文档项目不维护了 ,后续文档类相关资源维护官网项目里面。
我们介绍了SolidUI官网以及如何在GitHub上提交Issue和PR。SolidUI是一个AI生成的可视化原型和编辑平台,支持2D、3D模型,并结合了大型语言模型(LLM)以实现快速编辑。
参与到SolidUI的开发中,你可以通过提交Issue和PR来进行贡献。Issue用来报告bug或提出新的功能建议,而PR则用于提交你自己的代码更改。在提交PR时,应先在自己的fork仓库中创建或选择适当的开发分支(如dev分支),然后在该分支上进行更改。完成更改后,你可以创建一个PR,请求将你的更改合并到原项目中。
无论你是SolidUI的用户,还是希望贡献到项目的开发者,我们都欢迎你在GitHub上提交Issue和PR,共同推动SolidUI的发展。
SolidUI-Website贡献者
SolidUI-Website 官网 的发布离不开 SolidUI 社区的贡献者,感谢所有的社区贡献者,包括但不仅限于以下 Contributors(排名不分先后)
- dlimeng
- 15100399015
- limingoo
鸣谢
感谢streampark-website提供框架支持
如果成为贡献者
- 官方文档贡献。发现文档的不足、优化文档,持续更新文档等方式参与社区贡献。通过文档贡献,让开发者熟悉如何提交PR和真正参与到社区的建设。参考攻略:https://github.com/CloudOrc/SolidUI/discussions/54
- 代码贡献。我们梳理了社区中简单并且容易入门的的任务,非常适合新人做代码贡献。请查阅新手任务列表:https://github.com/CloudOrc/SolidUI/issues/12
- 内容贡献:发布SolidUI开源组件相关的内容,包括但不限于安装部署教程、使用经验、案例实践等,形式不限,请投稿给小助手。例如:https://github.com/CloudOrc/SolidUI/issues/10
- 社区答疑:积极在社区中进行答疑、分享技术、帮助开发者解决问题等;
其他:积极参与社区活动、成为社区志愿者、帮助社区宣传、为社区发展提供有效建议等;