space-wizards / space-wizards/docs

SS14 by example needs rejigging

Open
#20 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

!! IMPORTANT !! Content Guides/Onboarding Needs Cleanup Needs Docs Out of Date
Dominant language
CSS
Stars
42
Forks
304
PR merge metrics
No merged PRs in 30d

Description

i will probably end up doing this, but i want it to be less 'full fledged tutorials'-minded (except for the bikehorn one which is good) and more small examples of how to do specific things, a la other things like rust by example / dm by example

a lot of content documentation can be folded into this. engine docs too, probably. full-fledged docs should be relegated to stuff that really needs its own explanations outside of just code discoverability and basic FAQ stuff

this would make it significantly easier to iterate on and add new docs since you dont have to come up with a whole narrative for stuff--you just have questions and then answer them with code snippets, links, and short explainers

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

Start by reviewing the existing SS14 by example material and compare its structure with the linked Rust by Example and DM by Example references. Define a small-example structure with focused questions, code snippets, links, and short explanations, while identifying content that belongs in general or engine documentation. Done means the collection no longer depends on full tutorial narratives and has a clear structure for adding examples.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.