Xogot's Documentation Repo Is Public and Open for Contributions

We're excited to share that the XogotDocs repository is now public and open for contributions! Great documentation makes great tools even better. By opening XogotDocs to the public, we’re making it easier for anyone to help improve the learning experience for Xogot users.

docs.xogot.com running in Safari (powered by DocC)

We're excited to share that the XogotDocs repository is now public and open for contributions!

Great documentation makes great tools even better. By opening XogotDocs to the public, we’re making it easier for anyone to help improve the learning experience for Xogot users.

What's in the Repo?

XogotDocs hosts the content for docs.xogot.com, and includes two main types of articles:

  • Xogot-specific documentation: Articles and guides written to explain features unique to Xogot, like Differences between Godot and Xogot, Onscreen Controls, or working with Git via Working Copy.
  • Converted Godot docs: We’ve imported a large number of articles from Godot’s open-source documentation and converted them from reStructuredText format into Swift-style DocC Markdown, the format we use on our documentation site.

Many Docs Are Up. Many Still Need Love

Some articles were immediately ready for publication. Others still need review to make sure they reflect the actual Xogot experience. That includes:

  • Updating instructions to match workflows on iPad/iPhone
  • Replacing Godot screenshots with equivalent screenshots taken in Xogot
  • Flagging missing or outdated steps

This is where you come in.

Screenshot of a visual diff from a git commit updating a Xogot input map project settings screenshot
Configuring Input Maps in Godot versus Xogot

How You Can Contribute

Whether you’re an educator, student, developer, or enthusiast, there are lots of ways to pitch in:

  • Try an unpublished doc: Pick a draft that hasn’t gone live yet, try it out in Xogot, and submit a PR with edits, updates, or screenshots.

  • Submit small fixes: Found a typo or broken link in a published doc? Open a pull request—we welcome even the smallest contributions.

  • Report issues or suggestions: Not ready to submit a PR? You can open an issue in our GitHub issue tracker to let us know about errors, omissions, or confusing parts of the docs.

  • Email us directly: If you prefer, you can also send feedback privately to docs@xogot.com.

  • Join the conversation: We’ve launched a new #docs channel in the Xogot Discord. Jump in to ask questions, share ideas, or coordinate with others who want to help.

A diff of a tutorial step replacing mouse and keyboard cues with tap instructions
Touchifying docs

Licensing

The XogotDocs repository combines two sources of content under compatible open licenses.

When contributing, please ensure any new or updated content can be shared under the MIT License. This helps keep the documentation open and reusable for everyone.

A Community Effort

We see XogotDocs as a shared effort between our team and the amazing community that’s growing around iPad game development. With your help, we can make Xogot the best-documented way to make games—anywhere.

Come join us:
Source on GitHub
Issue tracker
Join #docs on Discord
Email docs@xogot.com

Let us know if you'd like to tackle a specific area. We’d be happy to help you get started.

Subscribe to Xogot Blog

Sign up now to be the first to know.
Guenter Gibbon
Subscribe