- Notifications
You must be signed in to change notification settings - Fork275
[WIP] Added built-in documentation#600
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
adriengivry wants to merge11 commits intomainChoose a base branch fromdoc/built-in-doc
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Draft
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
3d5bb0f to4051305CompareMemberAuthor
adriengivry commentedJun 16, 2025
For versioning, we can consider: |
062ccb1 to71f3cb3CompareSign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading.Please reload this page.
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 usinghugo.
Documentation/folderDocumentationproject to premake5 to generate the documentation when buildingOvEditorMenu Bar > Helpto include a "Documentation" button, which either open the locally generated documentation (version-specific) if available, or the newhttps://doc.overloadengine.org hosted version (latest only).OpenDocumentation.batscript to start a web server and open the documentation in the default web browser (mostly for development purposes, to preview the documentation while editing).README.mdto explain the new documentation generation workflow.To-Do
hugo.tomlandhugo-local.tomlfor online/offline buildsRelated Issue(s)
N/A
Review Guidance
Write here.
Screenshots/GIFs
Write here.