RoDoc (CONCEPT)

THIS IS ONLY A CONCEPT, NONE OF THIS IS REAL!

RoDoc

Roblox utility to add documentation for your scripts.

What would be some of the features?

Script

To add documentation/markdown to your script you would have to create a multiline comment that looks like this:

--[[
===
Name: "Script" (What name the plugin widget will show)
=== (Now just put some markdown below)

# Welcome to some docs
yeah i have no idea what to put here
]]

Plugin

The plugin would have 2 toolbar buttons:

1. Online documentation search

This button would open a widget in which it will prompt you to search for specific documentation online. (this info could be stored in a GitHub repository, where anyone can submit a pull request for putting in their own documentation) And also a recents section.

2. Open selected script

This will open the main widget, which will show the markdown text stored in the selected script. (The markdown will auto-parse, basically making the widget a live preview.)

Anyways for the people reading, once i script this, are there any other features that i should add?
I will script this later today.

1 Like