stride3d / stride3d/stride-docs

Suggestions for Improving Documentation Structure and Content

Open
#394 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

manual
Dominant language
PowerShell
Stars
39
Forks
74
Avg merge
3h 36m
Merged PRs (30d)
2

Description

Hi Stride team,

As an indie developer transitioning from Unity to Stride, I'd like to share some documentation improvement suggestions based on my onboarding experience. These adjustments could help future newcomers.

  1. Reorganize the "Distribute a Game" Section
    Current Location: Files and Folders → Distribute a Game
    Proposed Change: Move it under Get Started.
    Reason: The logical progression for new users should be:
    Install Engine → Create Project → Learn Basics → Build First Game → Test → Distribute
    The current placement under "Files and Folders" might be less intuitive for developers expecting a streamlined workflow.

  2. Missing Android Platform Documentation
    Issue: The "Platforms" section lacks dedicated guidance for Android. This is critical for mobile developers.
    Possible Solutions:
    Add an "Android" subsection under Platforms. If the documentation exists elsewhere, please move it to Platforms.

  3. Request for a "Q&A" Section
    Purpose: Centralize solutions to common issues (e.g., build errors, dependency setup). If there's new issues form Discord or other platforms, the document administrator can update the content in the Q&A section in a timely manner。

Attached is a sample Q&A document (Q&A ver0.0.1.docx) demonstrating how solutions could be formatted.

  1. Submission of an Android Build Tutorial
    Background: Many developers (especially those migrating from Unity) may not anticipate Stride's Android build prerequisites.

Attached File: [Android Tutorial.docx]Provides a step-by-step guide from environment setup to APK generation.
AND I WANT TO KEEP "FINAL WORDS", I REALLY DO! PLEASE KEEP!!

Note: Some screenshots are in Chinese. You may have to replace them with English screenshots if needed.

Finally, wish you a smooth development

Q&A ver0.0.1.docx
Android Tutorial.docx

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing “Distribute a Game” and “Platforms” documentation, then read the attached Q&A and Android Tutorial documents. Check the repository’s documentation build instructions before planning the navigation, Android coverage, and Q&A content. Done means the agreed documentation changes are integrated, screenshots are suitable for the audience, and the site builds successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, unity
Domain
documentation, mobile-dev
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.