stride3d / stride3d/stride-docs
Suggestions for Improving Documentation Structure and Content
Nobody has claimed this yet.
- 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.
-
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. -
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. -
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.
- 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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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