Skip to content

[DOCS] begginer-friendly documentation #447

@Dobya11

Description

@Dobya11

priority:low

Documentation Issue Type

  • Typo or grammatical error
  • Incorrect or outdated information
  • Unclear explanation or confusing content
  • Missing documentation for a topic
  • Broken links or images
  • Code example not working
  • Other (please describe)

Currently, the documentation has few features and conveniences for beginners.
My idea consists of several, the goal of which is to help newcomers understand the world of Hytale modding.

  1. Improve Existing Content & Explain Starting Point -should-have
    • Clarify the minimal steps a beginner should follow.
    • Add a short note on what is the first thing to do to get started in Hytale modding.
  2. Skill Levels with Practical Goals - optional
  • Beginner – essential steps to create the first mod. Should be clearly marked and come first.
  • Intermediate – optional steps for creating a more complex mod. Can include additional methods, tips, and code examples. And also publishing.
  • Advanced – optional steps for using advanced features. Marked as optional for experienced users.
  1. Callout: Prerequisites - optional
    • Highlight key concepts or knowledge users should understand before starting.
    • Examples: basic Java syntax, file structure of a Hytale mod, ECS basics.
  2. Increase Number of Methods & Examples - optional
    • Expand the number of practical examples for beginners.
    • Include more hands-on tasks, code snippets, or small exercises to follow along.
  3. Other ideas
    • Short glossary explaining key terms used in modding.
    • Video or GIF demonstrations for certain steps (setting up project, creating first mod, etc.)
    • Optional callouts for tricky concepts or advanced tips.

Linked PRs

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions