Low level documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- csharp
- Domain
- documentation
Research direction
Start by reading the existing comments on the ContentSerializer, DataSerializer, and IReference classes, then map the core Engine concepts across the relevant csproj projects. Document the build system, serialization model, and overall architecture, with per-csproj README files where useful; done means the questions in the issue are answered clearly for contributors.
Written by the indexing model from the issue text.
Description
As discussed on Discord server, it seems there's no real low level documentation about the core concepts of the Engine. It should be really useful to document them in order to contribute at the project, or at least as reference. For example concepts regarding the Build system and the Serialization of data in general. And the Big-Picture of Stride Engine (as mentionned @xen2 ).
Some questions in my mind :
- What is the difference between a ContentSerializer and a
DataSerializer? - How is composed a chunk of serialized data ?
- How the
IReferenceinterface works together with the serialization system ?
I am of course reading comments on all classes but I think there are some missing notions which seem to be important for me.
As another user mentionned on Discord, a readme file per csproj should be already a great start.
Thank you.
- Dominant language
- PowerShell
- Stars
- 39
- Forks
- 74
- Avg merge
- 3h 36m
- Merged PRs (30d)
- 2
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.
More from stride3d/stride-docs
-
ci-cd site-generator
stride3d/stride-docs#556 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
stride3d/stride-docs#554 ·
-
content help wanted manual p4
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
stride3d/stride-docs#547 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
stride3d/stride-docs#527 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 70/100
stride3d/stride-docs#526 · 1 comment ·
All issues in stride3d/stride-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·