Skip to content

Commit c43ff1e

Browse files
okunamayanadItsNeil17LaophyOmeWillem
authored
chore: merge branch "documentation" to "main" (#33)
* feat: 📝 Text Based Scripting documentation Fixes: #10 * chore: add git-info.json to gitignore Signed-off-by: ItsNeil17 <neil@willofsteel.me> * chore: move text-based to 'WWKSF' category Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add ways to develop category Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add icons Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: replace unicode icons with text Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add CODEOWNERS file * chore: move CODEOWNERS to .github Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add inputs page Closes #6 Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add ui customization page fixes #16 Signed-off-by: ItsNeil17 <neil@willofsteel.me> * refactor: rename text-based.mdx to plugin.mdx Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add visual scripting page Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add data assets page Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add modelling / texture art page Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add 'Documentation in Progress' banner at the top of the website Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add base fumadocs components Signed-off-by: ItsNeil17 <neil@willofsteel.me> * chore: cleanup readme boilerplate * chore : convert npm to bun in readme docs * chore: implement github community standards for open source * chore: ensure bun audit is ran before merging (pr template) * chore: add contact email * chore: remove discord comment * chore: fix README to include forks instead of cloning main repo * feat: remove fumadocs components in favor of feat/ui Signed-off-by: ItsNeil17 <neil@willofsteel.me> * docs: add new Q&A documentation gathered from discord * chore: add Laophy as CODEOWNER * chore: remove ai garbage * chore: change mana to hunger * feat: updated structure I think this is pretty neat! * fix: removed icon from seperator * fix: change up style of Q&A Summary Signed-off-by: ItsNeil17 <neil@willofsteel.me> * fix: move developer qa insights to root Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat!: implement new UI (#32) * feat: 📝 Text Based Scripting documentation Fixes: #10 * chore: add git-info.json to gitignore Signed-off-by: ItsNeil17 <neil@willofsteel.me> * chore: move text-based to 'WWKSF' category Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add ways to develop category Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add icons Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: replace unicode icons with text Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add CODEOWNERS file * chore: move CODEOWNERS to .github Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: update CODEOWNERS Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add new UI Co-authored-by: @okunamayanad <baran@okunamayanad.com> Signed-off-by: ItsNeil17 <neil@willofsteel.me> * refactor: refactor AI written code to use css vars * refactor: use prettier to format the code also added tailwindcss plugin to prettier * fix: put the 'WIP DOCS' banner in the center Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: make separator as long as the title Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add capsule block quote pill Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add styles for anchor links Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add hover animation Signed-off-by: ItsNeil17 <neil@willofsteel.me> * fix: theme selector Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: 📝 Text Based Scripting documentation Fixes: #10 * chore: move text-based to 'WWKSF' category Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add ways to develop category Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add icons Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: replace unicode icons with text Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add CODEOWNERS file * chore: move CODEOWNERS to .github Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add inputs page Closes #6 Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add ui customization page fixes #16 Signed-off-by: ItsNeil17 <neil@willofsteel.me> * refactor: rename text-based.mdx to plugin.mdx Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add visual scripting page Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add data assets page Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add modelling / texture art page Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add 'Documentation in Progress' banner at the top of the website Signed-off-by: ItsNeil17 <neil@willofsteel.me> * feat: add base fumadocs components Signed-off-by: ItsNeil17 <neil@willofsteel.me> * chore: cleanup readme boilerplate * chore : convert npm to bun in readme docs * chore: implement github community standards for open source * chore: ensure bun audit is ran before merging (pr template) * chore: add contact email * chore: remove discord comment * docs: add new Q&A documentation gathered from discord * chore: fix README to include forks instead of cloning main repo * feat: remove fumadocs components in favor of feat/ui Signed-off-by: ItsNeil17 <neil@willofsteel.me> * chore: add Laophy as CODEOWNER * chore: remove ai garbage * chore: change mana to hunger * feat: updated structure I think this is pretty neat! * fix: removed icon from seperator * fix: change up style of Q&A Summary Signed-off-by: ItsNeil17 <neil@willofsteel.me> * fix: move developer qa insights to root Signed-off-by: ItsNeil17 <neil@willofsteel.me> * chore: fix merge conflicts Signed-off-by: ItsNeil17 <neil@willofsteel.me> * fix: merge conflicts Signed-off-by: ItsNeil17 <neil@willofsteel.me> --------- Signed-off-by: ItsNeil17 <neil@willofsteel.me> Co-authored-by: Baran Mordoğan <baran@okunamayanad.com> Co-authored-by: Laophy <jpessman22@gmail.com> Co-authored-by: Willem <94999824+OmeWillem@users.noreply.github.com> * fix: props for DocsPage Signed-off-by: ItsNeil17 <neil@willofsteel.me> * fix: remove duplicate title Signed-off-by: ItsNeil17 <neil@willofsteel.me> * fix: change WIP alert Signed-off-by: ItsNeil17 <neil@willofsteel.me> * revert: revert custom documentation UI changes --------- Signed-off-by: ItsNeil17 <neil@willofsteel.me> Co-authored-by: Neil <neil@willofsteel.me> Co-authored-by: Laophy <jpessman22@gmail.com> Co-authored-by: Willem <94999824+OmeWillem@users.noreply.github.com>
1 parent f1c4b6a commit c43ff1e

39 files changed

Lines changed: 1584 additions & 67 deletions

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
* @ItsNeil17
22

33
/content/docs/what-we-know-so-far/ways-to-develop/text-based.mdx @okunamayanad
4+
/content/docs/what-we-know-so-far/developer-qa-insights.mdx @Laophy
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue with the documentation site
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
## Expected Behavior
21+
22+
A clear and concise description of what you expected to happen.
23+
24+
## Actual Behavior
25+
26+
A clear and concise description of what actually happened.
27+
28+
## Screenshots
29+
30+
If applicable, add screenshots to help explain your problem.
31+
32+
## Environment
33+
34+
- **Browser**: [e.g., Chrome 120, Firefox 121]
35+
- **OS**: [e.g., Windows 11, macOS 14, Linux Ubuntu 22.04]
36+
- **Device**: [e.g., Desktop, Mobile, Tablet]
37+
- **Screen Resolution**: [e.g., 1920x1080]
38+
39+
## Additional Context
40+
41+
Add any other context about the problem here. This might include:
42+
- When did you first notice this issue?
43+
- Does it happen consistently or intermittently?
44+
- Have you tried any workarounds?
45+
46+
## Possible Solution
47+
48+
If you have suggestions on how to fix the bug, please share them here.
49+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Discord Community
4+
url: https://discord.gg/54WX832HBM
5+
about: Join our Discord for real-time help and discussions
6+
- name: Official Hytale Website
7+
url: https://hytale.com/
8+
about: Visit the official Hytale website for game information
9+
- name: Hytale Modding Strategy
10+
url: https://hytale.com/news/2025/11/hytale-modding-strategy-and-status
11+
about: Read about Hytale's official modding strategy and roadmap
12+
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: Documentation Issue
3+
about: Report errors, unclear content, or missing information in the documentation
4+
title: '[DOCS] '
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue Type
10+
11+
- [ ] Typo or grammatical error
12+
- [ ] Incorrect or outdated information
13+
- [ ] Unclear explanation or confusing content
14+
- [ ] Missing documentation for a topic
15+
- [ ] Broken links or images
16+
- [ ] Code example not working
17+
- [ ] Other (please describe)
18+
19+
## Location
20+
21+
**Page/File**: [e.g., `/docs/quick-start` or `content/docs/what-we-know-so-far/plugin.mdx`]
22+
23+
**Section**: [e.g., "Installation" heading, line 45-50]
24+
25+
## Issue Description
26+
27+
A clear and concise description of the documentation issue.
28+
29+
## Current Content
30+
31+
If applicable, paste or quote the current content that needs to be fixed:
32+
33+
```
34+
Current content here...
35+
```
36+
37+
## Suggested Improvement
38+
39+
If you have suggestions for how to improve or fix the content:
40+
41+
```
42+
Suggested content here...
43+
```
44+
45+
## Additional Context
46+
47+
- Why is this confusing or incorrect?
48+
- What were you trying to accomplish when you found this issue?
49+
- Are there any official Hytale sources that clarify this topic?
50+
51+
## Related Issues
52+
53+
Link any related issues or pull requests here.
54+
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for the documentation site
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Type
10+
11+
- [ ] New documentation topic
12+
- [ ] Site functionality improvement
13+
- [ ] UI/UX enhancement
14+
- [ ] Search improvement
15+
- [ ] Navigation enhancement
16+
- [ ] Developer experience
17+
- [ ] Other (please describe)
18+
19+
## Problem Statement
20+
21+
**Is your feature request related to a problem? Please describe.**
22+
23+
A clear and concise description of what the problem is. For example: "I'm always frustrated when [...]" or "It's difficult to find information about [...]"
24+
25+
## Proposed Solution
26+
27+
**Describe the solution you'd like**
28+
29+
A clear and concise description of what you want to happen. Include:
30+
- What should be added or changed?
31+
- How would this help users?
32+
- What would the user experience look like?
33+
34+
## Alternative Solutions
35+
36+
**Describe alternatives you've considered**
37+
38+
A clear and concise description of any alternative solutions or features you've considered.
39+
40+
## Benefits to the Community
41+
42+
Who would benefit from this feature and how?
43+
- [ ] Beginners learning Hytale modding
44+
- [ ] Experienced plugin developers
45+
- [ ] Content creators and modelers
46+
- [ ] Documentation contributors
47+
- [ ] Site visitors in general
48+
49+
## Implementation Ideas
50+
51+
If you have ideas about how this could be implemented:
52+
- Technical approach
53+
- Required resources
54+
- Potential challenges
55+
56+
## Examples
57+
58+
Provide examples of similar features in other documentation sites or projects:
59+
- [Link to example 1]
60+
- [Link to example 2]
61+
62+
## Additional Context
63+
64+
Add any other context, screenshots, or mockups about the feature request here.
65+
66+
## Hytale Relevance
67+
68+
How does this relate to Hytale modding specifically?
69+
- Does it address a specific Hytale modding concept?
70+
- Is it based on official Hytale information?
71+
- Would it help with server-first development, plugins, data assets, etc.?
72+

.github/ISSUE_TEMPLATE/question.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Question
3+
about: Ask a question about the documentation or Hytale modding
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
11+
What would you like to know?
12+
13+
## Context
14+
15+
Please provide context for your question:
16+
- What are you trying to accomplish?
17+
- What have you already tried?
18+
- Where did you look for answers?
19+
20+
## Related Documentation
21+
22+
Have you checked the following resources?
23+
- [ ] This documentation site
24+
- [ ] [Official Hytale Blog](https://hytale.com/news)
25+
- [ ] [Hytale Modding Strategy Post](https://hytale.com/news/2025/11/hytale-modding-strategy-and-status)
26+
- [ ] Community Discord
27+
- [ ] Searched existing issues
28+
29+
## Your Skill Level
30+
31+
This helps us provide an appropriate answer:
32+
- [ ] New to Hytale modding
33+
- [ ] Some experience with modding
34+
- [ ] Experienced modder
35+
- [ ] Professional developer
36+
37+
## Modding Category
38+
39+
What aspect of Hytale modding does your question relate to?
40+
- [ ] Server plugins (Java)
41+
- [ ] Data assets (JSON)
42+
- [ ] Art assets (Blockbench, textures, models)
43+
- [ ] Visual scripting
44+
- [ ] World generation
45+
- [ ] General concepts
46+
- [ ] Documentation site itself
47+
- [ ] Other
48+
49+
## Additional Information
50+
51+
Add any other relevant information, code snippets, or screenshots here.
52+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Brief description of what this PR does.
6+
7+
## Type of Change
8+
9+
- [ ] Documentation fix (typo, grammar, clarification)
10+
- [ ] New documentation (guide, tutorial, page)
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Other
14+
15+
## Related Issues
16+
17+
Fixes #(issue)
18+
19+
## Changes
20+
21+
-
22+
-
23+
-
24+
25+
## Screenshots
26+
27+
If applicable, add before/after screenshots:
28+
29+
## Checklist
30+
31+
- [ ] Tested locally with `bun run dev`
32+
- [ ] Ran `bun audit` (no critical vulnerabilities)
33+
- [ ] Checked spelling and grammar
34+
- [ ] Verified all links work
35+
- [ ] Followed [Contributing Guidelines](../CONTRIBUTING.md)
36+
37+
---
38+
39+
Thank you for contributing!
40+

CODE_OF_CONDUCT.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our Hytale modding documentation community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community focused on helping everyone learn and succeed in Hytale modding.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
- Helping newcomers get started with Hytale modding
19+
- Sharing knowledge and resources generously
20+
- Providing clear, accurate documentation
21+
22+
Examples of unacceptable behavior include:
23+
24+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
25+
- Trolling, insulting or derogatory comments, and personal or political attacks
26+
- Public or private harassment
27+
- Publishing others' private information, such as a physical or email address, without their explicit permission
28+
- Spreading misinformation or deliberately misleading documentation
29+
- Other conduct which could reasonably be considered inappropriate in a professional setting
30+
31+
## Enforcement Responsibilities
32+
33+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
34+
35+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
36+
37+
## Scope
38+
39+
This Code of Conduct applies within all community spaces, including but not limited to:
40+
41+
- GitHub repositories and discussions
42+
- Discord servers
43+
- Community forums and social media
44+
- Virtual or in-person events representing the community
45+
46+
It also applies when an individual is officially representing the community in public spaces.
47+
48+
## Enforcement
49+
50+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement via GitHub issues or Discord moderators.
51+
52+
All complaints will be reviewed and investigated promptly and fairly.
53+
54+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
55+
56+
## Enforcement Guidelines
57+
58+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
59+
60+
### 1. Correction
61+
62+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
63+
64+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
65+
66+
### 2. Warning
67+
68+
**Community Impact**: A violation through a single incident or series of actions.
69+
70+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
71+
72+
### 3. Temporary Ban
73+
74+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
75+
76+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
77+
78+
### 4. Permanent Ban
79+
80+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
81+
82+
**Consequence**: A permanent ban from any sort of public interaction within the community.
83+
84+
## Attribution
85+
86+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
87+
88+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
89+
90+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
91+

0 commit comments

Comments
 (0)