Documentation! #23

New Issue

MayaTheShy · 2019-11-10T13:36:35-05:00

Kan18 commented

2019-11-10 13:36:35 -05:00

(Migrated from github.com)

A major problem with Opus is the lack of documentation for its programs and modules. The only ways to learn how to use them are to read the code or learn from somebody else. Opus should have a central documentation source for all of its features, modules, and programs. There are some ways to approach this

Idea 1 - create a "opus-docs" repository
Idea 2 - add documentation on the GitHub wiki
Idea 3 - create documentation in-game (using help program)

Ideas 1 or 2 could also have in-game representations by stripping the markdown then displaying it in-game

A major problem with Opus is the lack of documentation for its programs and modules. The only ways to learn how to use them are to read the code or learn from somebody else. Opus should have a central documentation source for all of its features, modules, and programs. There are some ways to approach this Idea 1 - create a "opus-docs" repository Idea 2 - add documentation on the GitHub wiki Idea 3 - create documentation in-game (using help program) Ideas 1 or 2 could also have in-game representations by stripping the markdown then displaying it in-game

kepler155c commented

2019-11-13 12:06:29 -05:00

(Migrated from github.com)

For programs, I am currently using the built-in help system (along with a Help UI program). Each package can supply a help directory with help files included.

For the UI API (the most complex), I have been working on an inspector program that will hopefully act as a self documenting API tool (see the latest update which contains an inspect program).

I also have some info in the Wiki on Github - the plan was to duplicate the wiki pages to help files.

For programs, I am currently using the built-in help system (along with a Help UI program). Each package can supply a help directory with help files included. For the UI API (the most complex), I have been working on an inspector program that will hopefully act as a self documenting API tool (see the latest update which contains an inspect program). I also have some info in the Wiki on Github - the plan was to duplicate the wiki pages to help files.

MayaTheShy referenced this issue

2026-03-22 15:29:01 -04:00

Complet API #67

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: MayaTheShy/Opus#23