Could we provide a glossary?

[ccmywish]

Last year, I tried to read the source code of mruby. However, I only managed to handle the parser part, the VM part is more difficult to understand. So, could we provide a glossary like @tenderlove 's https://github.com/tenderlove/ruby-glossary ?

And I suggest maintaining a dictionary using this cr.rb cli tool.

Although the issue tenderlove/ruby-glossary#1 is denied, I still think using a cli tool as a dictionary tool to understand our code is helpful. In fact, we can make the glossary just a README.md file for the dictionary repo.

images example

[dearblue]

I think it is a good idea that a glossary exists.
But what about adding it as mruby/doc/glossary.md instead of a separate repository?
I believe it is not difficult to convert to another format (.toml in cr.rb?) even if it is markdown, as long as we set some rules.

For example (?),

## Internal Implements <!-- category -->

### callinfo <!-- wording -->

<!-- text -->
It means "Call Information".
Manages control information about running methods or blocks.

acronyms: ci <!-- attribute for acronyms -->

see also: ... <!-- attribute for relational wordings -->

[rubyFeedback]

I agree it would be nice to have it into doc/ - it can be kept in a variant others can then use to e. g. generate other format/variants. Biggest first issue is always getting people to commit to documentation - everyone wants to prefer on the code. :)

[ccmywish]

Hi @dearblue and @rubyFeedback,

I agree with you.

I think it is really better to save it in to /doc. tenderlove's ruby glossary has also been merged into official ruby repo.

I've updated cr.rb and now manually maintain two repos to keep track both of them irregularly. And welcome contributions!

1. https://github.com/ccmywish/CRuby-Source-Code-Dictionary
2. https://github.com/ccmywish/mruby-Source-Code-Dictionary

Usage:

gem install cr.rb
cr -a ccmywish/CRuby-Source-Code-Dictionary
cr -a ccmywish/mruby-Source-Code-Dictionary