Skip to content

Commit 974cdd5

Browse files
committed
docs: update assets and git info
1 parent ae765b2 commit 974cdd5

File tree

28 files changed

+283
-427
lines changed

28 files changed

+283
-427
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve Once UI
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
## Describe the bug
10+
A clear and concise description of what the bug is.
11+
12+
## To reproduce
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '...'
16+
3. Scroll down to '...'
17+
4. See error
18+
19+
## Expected behavior
20+
A clear and concise description of what you expected to happen.
21+
22+
## Screenshots
23+
If applicable, add screenshots to help explain your problem.
24+
25+
## Environment
26+
Please complete the following information:
27+
- **OS**: [e.g. macOS, Windows, Linux]
28+
- **Browser**: [e.g. Chrome 120, Safari 17, Firefox 121]
29+
- **Once UI Version**: [e.g. 1.5.0]
30+
- **Next.js Version**: [e.g. 14.0.0]
31+
- **Node.js Version**: [e.g. 18.17.0]
32+
33+
## Code Sample
34+
```tsx
35+
// Please provide a minimal code example that reproduces the issue
36+
```
37+
38+
## Additional context
39+
Add any other context about the problem here. For example:
40+
- Does this happen consistently or intermittently?
41+
- Did this work in a previous version?
42+
- Are there any console errors or warnings?
43+
44+
## Possible solution
45+
If you have an idea of what might be causing the issue or how to fix it, please share it here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📚 Documentation
4+
url: https://docs.once-ui.com
5+
about: Check out our documentation for guides and API references
6+
- name: 💬 Discord Community
7+
url: https://discord.com/invite/5EyAQ4eNdS
8+
about: Join our Discord for help, support and discussion with the community
9+
- name: 🔍 Discussions
10+
url: https://github.com/once-ui-system/core/discussions
11+
about: Ask questions and discuss ideas with the community
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for Once UI
4+
title: '[FEATURE] '
5+
labels: 'feature request'
6+
assignees: ''
7+
---
8+
9+
## Is your feature request related to a problem? Please describe.
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
## Describe the solution you'd like
13+
A clear and concise description of what you want to happen.
14+
15+
## Describe alternatives you've considered
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
## Use Case
19+
Describe the use case for this feature. How would it benefit Once UI users?
20+
21+
## Example API (if applicable)
22+
```tsx
23+
// Show how you envision the feature being used
24+
<Component
25+
newProp="value"
26+
>
27+
Content
28+
</Component>
29+
```
30+
31+
## Additional context
32+
Add any other context, screenshots, or examples about the feature request here.
33+
34+
## Would you be willing to contribute?
35+
- [ ] Yes, I'd like to work on this feature
36+
- [ ] No, but I can help test it
37+
- [ ] No, just suggesting the idea

.github/ISSUE_TEMPLATE/question.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Question or Help
3+
about: Ask a question about using Once UI
4+
title: '[QUESTION] '
5+
labels: 'question'
6+
assignees: ''
7+
---
8+
9+
## Your Question
10+
A clear and concise description of what you're trying to achieve or understand.
11+
12+
## What I've tried
13+
Describe what you've already attempted:
14+
- [ ] Checked the [documentation](https://docs.once-ui.com)
15+
- [ ] Searched existing issues
16+
- [ ] Asked in Discord
17+
18+
## Code Example
19+
```tsx
20+
// Share relevant code if applicable
21+
```
22+
23+
## Expected outcome
24+
What are you trying to accomplish?
25+
26+
## Additional context
27+
Add any other context, screenshots, or links that might help us understand your question.
28+
29+
---
30+
31+
💡 **Tip**: For faster responses, consider asking in our [Discord community](https://discord.com/invite/5EyAQ4eNdS) where community members can help!

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Before submitting a PR:
5151

5252
### Best practices
5353

54-
- Follow our [component conventions](https://docs.once-ui.com/once-ui/components) and file structure.
54+
- Follow our [component conventions](https://docs.once-ui.com/once-ui/basics/components) and file structure.
5555
- Use the naming system and design tokens already defined in the project.
5656

5757
## Join the community

packages/core/LICENSE renamed to LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

Lines changed: 33 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,54 @@
1-
## Once UI monorepo
1+
<br/>
22

3-
This monorepo hosts the official Once UI package and its internal development sandbox. It is designed for testing, development, and contribution—not for production deployment.
3+
<div align="center">
4+
<picture>
5+
<source media="(prefers-color-scheme: dark)" srcset="https://docs.once-ui.com/trademark/icon-dark.svg" width="64" height="64">
6+
<source media="(prefers-color-scheme: light)" srcset="https://docs.once-ui.com/trademark/icon-light.svg" width="64" height="64">
7+
<img alt="Once UI Logo" src="https://docs.once-ui.com/trademark/icon-dark.svg" width="64" height="64">
8+
</picture><picture>
9+
<source media="(prefers-color-scheme: dark)" srcset="https://docs.once-ui.com/trademark/type-dark.svg" width="256" height="64">
10+
<source media="(prefers-color-scheme: light)" srcset="https://docs.once-ui.com/trademark/type-light.svg" width="256" height="64">
11+
<img alt="Once UI Wordmark" src="https://docs.once-ui.com/trademark/type-dark.svg" width="256" height="64">
12+
</picture>
413

5-
## Developer notice
14+
<br/>
615

7-
It includes:
16+
A design system for Next.js apps for indie builders.
817

9-
- `packages/core`: the published [@once-ui-system/core](https://www.npmjs.com/package/@once-ui-system/core) package
10-
- `apps/docs`: the official documentation of Once UI and Magic templates built with [Magic Docs](https://once-ui.com/products/magic-docs)
11-
- `apps/dev`: a simple sandbox app wired via symlink for testing components
18+
[![npm version](https://img.shields.io/npm/v/@once-ui-system/core.svg)](https://www.npmjs.com/package/@once-ui-system/core)
19+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE.md)
20+
[![npm downloads](https://img.shields.io/npm/dm/@once-ui-system/core.svg)](https://www.npmjs.com/package/@once-ui-system/core)
21+
[![Discord](https://img.shields.io/discord/5EyAQ4eNdS?color=7289da&logo=discord&logoColor=white)](https://discord.com/invite/5EyAQ4eNdS)
22+
</div>
1223

13-
This setup is intended for contributors and maintainers.
14-
If you're building a real project, we recommend using:
1524

16-
1. [Once UI Starter](https://github.com/once-ui-system/nextjs-starter)
17-
2. or install via your package manager:
1825

19-
```bash
20-
npm install @once-ui-system/core
21-
# or
22-
yarn add @once-ui-system/core
23-
# or
24-
pnpm add @once-ui-system/core
25-
```
26-
27-
### For contributors
28-
29-
Fork this repo, install dependencies, and run apps:
30-
31-
```bash
32-
pnpm install
33-
pnpm dev
34-
```
35-
36-
The components will update automatically when you make changes to the Core library. If you modify the CSS modules, you'll have to run `pnpm build` in the `packages/core` directory.
26+
<br/>
3727

3828
## Documentation
3929

40-
Start here: [docs.once-ui.com](https://docs.once-ui.com/once-ui/quick-start).
41-
42-
## Creators
30+
Learn how to set up and build with Once UI at [docs.once-ui.com](https://docs.once-ui.com/once-ui/quick-start).
4331

44-
**Lorant One**: [Portfolio](https://lorant.one) / [Threads](https://www.threads.net/@lorant.one) / [LinkedIn](https://www.linkedin.com/in/lorant-one/)
32+
## Installation
4533

46-
**Collaborators**: [Once UI Frontiers](https://once-ui.com/about)
34+
```bash
35+
npm install @once-ui-system/core
36+
```
4737

48-
## Join the movement
38+
## Authors
4939

50-
![Design Engineers Club](https://docs.once-ui.com/images/docs/vibe-coding-dark.jpg)
40+
Built and maintained by [**Lorant One**](https://lorant.one).
5141

52-
Join the [Design Engineers Club](https://discord.com/invite/5EyAQ4eNdS) on Discord. Build with intention. Share with integrity.
42+
## Community
5343

54-
## Feedback & Bugs
44+
Join the [Design Engineers Club](https://discord.com/invite/5EyAQ4eNdS) for help, support and discussion.
5545

56-
Found a bug? [Report it](https://github.com/once-ui-system/core/issues/new?labels=bug&template=bug_report.md)
57-
Got an idea? [Submit a request](https://github.com/once-ui-system/core/issues/new?labels=feature%20request&template=feature_request.md)
46+
Found a bug? Report it [here](https://github.com/once-ui-system/core/issues/new?labels=bug&template=bug_report.md). Got a feature request? Submit it [here](https://github.com/once-ui-system/core/issues/new?labels=feature%20request&template=feature_request.md).
5847

59-
## Support us
48+
## Contributing
6049

61-
Once UI is an indie project. [Sponsor us](https://github.com/sponsors/once-ui-system) and get featured on our site!
50+
Please read our [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to Once UI.
6251

63-
## License
52+
## Sponsors
6453

65-
Distributed under the MIT License. See `LICENSE.txt`.
54+
Once UI is an indie project. [Sponsor us](https://github.com/sponsors/once-ui-system) and get featured on our site!

apps/docs/LICENSE

Lines changed: 0 additions & 17 deletions
This file was deleted.

apps/docs/README.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)