Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SS14 by example needs rejigging #20

Open
mirrorcult opened this issue Sep 21, 2023 · 1 comment
Open

SS14 by example needs rejigging #20

mirrorcult opened this issue Sep 21, 2023 · 1 comment
Labels
Content Relevant to documentation of Space Station 14-specific code. Guides/Onboarding Related to guide/tutorial documentation and/or onboarding/developer setup !! IMPORTANT !! HIGH URGENCY. HELP Needs Cleanup Relevant to documentation which needs cleanup, either to be atomized or folded into other pages. Needs Docs Relevant to documentation which will require entirely new pages or rewriting. Out of Date Relevant to pages which just need to be updated rather than rewritten or added.

Comments

@mirrorcult
Copy link
Contributor

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

@mirrorcult mirrorcult added Content Relevant to documentation of Space Station 14-specific code. Out of Date Relevant to pages which just need to be updated rather than rewritten or added. Needs Docs Relevant to documentation which will require entirely new pages or rewriting. Needs Cleanup Relevant to documentation which needs cleanup, either to be atomized or folded into other pages. !! IMPORTANT !! HIGH URGENCY. HELP labels Sep 21, 2023
@nok-ko
Copy link

nok-ko commented Dec 12, 2023

Is there a list of common things by-example things specific to our project that you have in mind?

I’m also quite new at working with the SS14 codebase; Can you think of game systems that have the most "known-good"/solid feature code that I can use for reference?

@Jezithyr Jezithyr added the Guides/Onboarding Related to guide/tutorial documentation and/or onboarding/developer setup label Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content Relevant to documentation of Space Station 14-specific code. Guides/Onboarding Related to guide/tutorial documentation and/or onboarding/developer setup !! IMPORTANT !! HIGH URGENCY. HELP Needs Cleanup Relevant to documentation which needs cleanup, either to be atomized or folded into other pages. Needs Docs Relevant to documentation which will require entirely new pages or rewriting. Out of Date Relevant to pages which just need to be updated rather than rewritten or added.
Projects
None yet
Development

No branches or pull requests

3 participants