Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[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 intomain
base:main
Choose a base branch
Loading
fromdoc/built-in-doc
Draft

Conversation

@adriengivry
Copy link
Member

@adriengivryadriengivry commentedJun 13, 2025
edited
Loading

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.

  • Moved documentation fromWiki to newDocumentation/ folder
  • Added aDocumentation project to premake5 to generate the documentation when buildingOvEditor
  • UpdatedMenu Bar > Help to 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).
  • AddedOpenDocumentation.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).
  • UpdatedREADME.md to explain the new documentation generation workflow.

To-Do

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

Related Issue(s)

N/A

Review Guidance

Write here.

Screenshots/GIFs

Write here.

@adriengivryadriengivry self-assigned thisJun 13, 2025
@adriengivryadriengivry added the DocumentationImprovements or additions to documentation labelJun 13, 2025
@adriengivryadriengivryforce-pushed thedoc/built-in-doc branch 3 times, most recently from3d5bb0f to4051305CompareJune 13, 2025 20:41
@adriengivryadriengivry changed the titleAdded built-in documentation[WIP] Added built-in documentationJun 13, 2025
@adriengivry
Copy link
MemberAuthor

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

@adriengivryadriengivryforce-pushed thedoc/built-in-doc branch 3 times, most recently from062ccb1 to71f3cb3CompareJune 17, 2025 15:11
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

No reviews

Assignees

@adriengivryadriengivry

Labels

DocumentationImprovements or additions to documentation

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@adriengivry

[8]ページ先頭

©2009-2025 Movatter.jp