Skip to content

Conversation

@adriengivry
Copy link
Member

@adriengivry adriengivry commented Jun 13, 2025

Description

The objective of this PR is to add documentation directly inside of Overload's repository, making it easy for any contributor to update it alongside PRs, as well as versioning it (e.g. the scripting API might change from one version to another, so having it alongside the code makes this easier).

A website can be statically generated from the documentation using hugo.

  • Moved documentation from Wiki to new Documentation/ folder
  • Added a Documentation project to premake5 to generate the documentation when building OvEditor
  • Updated Menu Bar > Help to include a "Documentation" button, which either open the locally generated documentation (version-specific) if available, or the new https://doc.overloadengine.org hosted version (latest only).
  • Added OpenDocumentation.bat script to start a web server and open the documentation in the default web browser (mostly for development purposes, to preview the documentation while editing).
  • Updated README.md to explain the new documentation generation workflow.

To-Do

  • Move tutorial/documentation images from github to local
  • Setup https://doc.overloadengine.org
  • Validate GitHub page deployment workflow
  • Find a way to avoid duplicating hugo.toml and hugo-local.toml for online/offline builds
  • Verify all new lua examples

Related Issue(s)

N/A

Review Guidance

Write here.

Screenshots/GIFs

Write here.

@adriengivry adriengivry self-assigned this Jun 13, 2025
@adriengivry adriengivry added the Documentation Improvements or additions to documentation label Jun 13, 2025
@adriengivry adriengivry force-pushed the doc/built-in-doc branch 3 times, most recently from 3d5bb0f to 4051305 Compare June 13, 2025 20:41
@adriengivry adriengivry changed the title Added built-in documentation [WIP] Added built-in documentation Jun 13, 2025
@adriengivry
Copy link
Member Author

For versioning, we can consider:
https://discourse.gohugo.io/t/documentation-site-versioning/5898/3

@adriengivry adriengivry force-pushed the doc/built-in-doc branch 3 times, most recently from 062ccb1 to 71f3cb3 Compare June 17, 2025 15:11
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

Development

Successfully merging this pull request may close these issues.

2 participants