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

Documentation Audit #43

Open
10 tasks
STREGA opened this issue Aug 18, 2023 · 1 comment
Open
10 tasks

Documentation Audit #43

STREGA opened this issue Aug 18, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@STREGA
Copy link
Contributor

STREGA commented Aug 18, 2023

  • Full public API DocC coverage
  • Refactor all SwiftLint errors and warnings

Special DocC Pages

  • Explain in detail: Game Lifecycle
  • Explain in detail: Window Management
  • Explain in detail: Entity, Component, System
  • Explain in detail: Resource Loading, Lifecycle (Cache)
  • Explain in detail: Custom File Importers
  • Explain in detail: Audio Playback
  • Explain in detail: Rendering
  • Explain in detail: UserInput
@STREGA STREGA added this to the v1.0.0 milestone Aug 18, 2023
@STREGA STREGA added the documentation Improvements or additions to documentation label Aug 19, 2023
@7ombie
Copy link

7ombie commented Jun 30, 2024

I'm still interested in this project, but the lack of docs just makes it a nonstarter (for me at least). It's a shame, as the project seems ideal otherwise.

Personally, I want teach my son programming (by hacking on games), and teach myself various things, like 3D graphics (so I can document the knowledge and monetize the docs). So, we don't need the most mature and featureful engine (we only care about macOS and HTML5, for example). In short, we'd be willing guinea pigs.

Without committing to anything in advance, I'm generally open to helping with the project's docs, but it'd take a lot of time for me to figure out and document the project with only the demos to go on. If there was more to work from already, it'd all be far less daunting.

Best wishes with your project, whatever happens. It's super impressive how far you've come with it.

P.S. Your Swift is also a joy to read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants