STREGAsGate/GateEngine

Documentation Audit

STREGA opened this issue · 1 comments

STREGA commented
  • 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
7ombie commented

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.

  • 👍1
  • ❤️1