# Link to doncumentation on github

**URL:** <https://www.ruby-forum.com/t/link-to-doncumentation-on-github/187582>\
**Category:** Rails I18n\
**Created:** [April 26, 2010, 9:42am UTC](https://www.ruby-forum.com/t/link-to-doncumentation-on-github/187582 "2010-04-26T09:42:27Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![albert](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/48db29/32.png) [@albert](https://www.ruby-forum.com/u/albert)\
**Post date:** [April 26, 2010, 9:42am UTC](https://www.ruby-forum.com/t/link-to-doncumentation-on-github/187582/1 "2010-04-26T09:42:27Z")

</div>

Just a small question, would it make sense to have the readme of the gem  
at  
least link to the Rails guide about  
I18n[http://guides.rubyonrails.org/i18n.html](http://guides.rubyonrails.org/i18n.html)?  
This is all completely my personal opinion, but trying to think like a  
person not familiar with i18n, the first problem I find is no  
documentation  
in the Readme. There’s a list of features, but no code whatsoever. Even  
the  
simplest example would help:

# es.yml

es:  
hello: “Hola”

# en.yml

en:  
hello: “en”

I18n.locale = :es  
I18n.t :hello # =\> “Hola”

The second problem is that the only link to documentation is to the  
wiki,  
which even though it looks quite improved, there’s again still no code  
and  
no examples, and the guides aren’t even in the first set of links. An  
introduction paragraph linking to the rails guide as the most complete  
(even  
when rails focused) would do much.

Again, this is all an opinion, but I’ve been asked quite basic questions  
about I18n the last weeks which are fully answered in the rails guides  
and  
that makes me think people just aren’t finding it. Another small matter  
would be that in the Rails guides page, the guide about i18n is called  
“Rails internationalization guide”, which is corrrect, but at least I  
always  
go looking for “I18n” when trying to find stuff about I18n, and not  
“internationalization”.

## What do you think?

{ :name =\> “Albert L.” }