XogotDocs contains the source documentation for Xogot, the iPad and iPhone
port of the Godot Engine developed by Xibbon, Inc..
The documentation is published at docs.xogot.com using
Apple’s DocC documentation system.
This repository serves as the authoring and build source for the Xogot documentation set. It combines original Xogot content written in DocC-compatible Markdown with material adapted from the open-source Godot Engine documentation, originally written in reStructuredText (reST).
All documentation can be edited, previewed, and built in Xcode, using the
included Xogot.xcodeproj and the Documentation.docc bundle as the primary
workspace.
| Path | Description |
|---|---|
.github/workflows |
GitHub Actions used to automatically build and publish the documentation from the main branch. |
Documentation.docc/ |
The main DocC bundle containing all documentation topics, resources, and metadata. |
Xogot.xcodeproj |
The Xcode project used to open, edit, and preview the documentation locally. |
Xogot/ |
A minimal Swift target that hosts the DocC catalog for Xcode previews. |
scripts/ |
Conversion and utility scripts for transforming upstream Godot reST files into DocC Markdown. |
Within Documentation.docc, the following directories and files are
particularly important:
| Folder | Description |
|---|---|
Manual/ |
Converted from godot-docs/tutorials. Contains adapted Godot tutorials. Files remain excluded from publication on docs.xogot.com until the placeholder comment <!-- Remove this line to publish to docs.xogot.com --> is removed. |
Tutorials/ |
Converted from godot-docs/getting-started. Entry-level guides for using Godot features within Xogot. |
Resources/ |
Contains images, example projects, and other resource files referenced by the documentation. |
Releases/ |
Includes release notes for TestFlight and App Store versions of Xogot. |
Documentation.md |
The top-level table of contents and navigation root for the published documentation. |
Additional articles may appear in the root of Documentation.docc and are
gradually being reorganized into subdirectories.
You can build and preview the documentation locally in Xcode.
- Open
Xogot.xcodeproj. - Select the Xogot scheme.
- Choose Product → Build Documentation or Product → Run to preview in the Documentation window.
The GitHub Actions workflow automatically rebuilds and republishes the site from
the main branch after each commit.
Contributions are welcome!
You can help by improving existing tutorials, fixing formatting issues, or
validating converted content in Xogot.
- To contribute, fork this repository and open a pull request.
- Join the discussion in the
#docschannel on the Xogot Discord. - Share feedback or report documentation issues through the XogotDocs issue tracker.
- For questions or errors, email [email protected].
When adapting Godot content, please retain the original attribution and
follow the conversion conventions used in the scripts/ folder.
Unless otherwise noted, all files in this repository are licensed under the MIT License © 2024-present Xibbon, Inc.
The following directories contain material adapted from the Godot Engine documentation:
Documentation.docc/ManualDocumentation.docc/Tutorials
Those directories are licensed under a combined structure:
- © 2014-present Juan Linietsky, Ariel Manzur and the Godot community
— licensed under the Creative Commons Attribution 3.0 Unported License (CC BY 3.0) - Modifications and additional content © 2024-present Xibbon, Inc.
— licensed under the MIT License
See the LICENSE file for full details.
© 2024-present Xibbon, Inc. – Documentation built with DocC