# Documenting Ruby Suggestions

**URL:** <https://www.ruby-forum.com/t/documenting-ruby-suggestions/244795>\
**Category:** Ruby-Gnome 2\
**Created:** [June 15, 2016, 9:55pm UTC](https://www.ruby-forum.com/t/documenting-ruby-suggestions/244795 "2016-06-15T21:55:54Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Sadaf\_N](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/s/858c86/32.png) [@Sadaf\_N](https://www.ruby-forum.com/u/Sadaf_N)\
**Post date:** [June 15, 2016, 9:55pm UTC](https://www.ruby-forum.com/t/documenting-ruby-suggestions/244795/1 "2016-06-15T21:55:54Z")

</div>

Hi Y’all

I’ve been working on documenting visualruby, and I’d like to get some of  
feedback of how to document it.

I found a great documenting tool called “yard” that is a great  
replacement for rdocs, but it still outputs basically an api looking  
document that wouldn’t make a great website.

Right now, I’m considering modifying the css to make it more readable,  
but I’d really like to find a solution where it generates an actual  
website.

Any suggestions?

Eric

---

<div class="post-metadata">

**Author:** ![ericrchr](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/e/8baadc/32.png) [@ericrchr](https://www.ruby-forum.com/u/ericrchr)\
**Post date:** [June 16, 2016, 6:04am UTC](https://www.ruby-forum.com/t/documenting-ruby-suggestions/244795/2 "2016-06-16T06:04:41Z")

</div>

I’m making progress on this. In fact I think I’m happy with it:

> **[hi合乐888在线登录 - hi合乐手机网页版](http://www.visualruby.net/)**
>
> ♠欢迎点击hi合乐888在线登录,hi合乐手机网页版早就成为了世界性的强大娱乐平台,hi合乐888在线登录提供最新、最好玩、最全的单机游戏中文版下载、资讯、攻略、补丁,致力成为行业风向标。

---

<div class="post-metadata">

**Author:** ![ericrchr](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/e/8baadc/32.png) [@ericrchr](https://www.ruby-forum.com/u/ericrchr)\
**Post date:** [June 18, 2016, 7:43pm UTC](https://www.ruby-forum.com/t/documenting-ruby-suggestions/244795/3 "2016-06-18T19:43:51Z")

</div>

I’ve been working on getting the documentation working. The “yard” gem  
is really valuable. I hacked the code slightly, and changed some css,  
and the website is very functional. In fact, I’m considering writing a  
GUI for yard.

I documented the “Download” page, so everyone can download it, and the  
“Signals Tutorial” because its sital to using visualruby. More to  
come…
