# How To View Documentation in doc/app

**URL:** <https://www.ruby-forum.com/t/how-to-view-documentation-in-doc-app/113866>\
**Category:** Rails\
**Created:** [September 5, 2007, 7:22pm UTC](https://www.ruby-forum.com/t/how-to-view-documentation-in-doc-app/113866 "2007-09-05T19:22:44Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![bezerker](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/3da27b/32.png) [@bezerker](https://www.ruby-forum.com/u/bezerker)\
**Post date:** [September 5, 2007, 7:22pm UTC](https://www.ruby-forum.com/t/how-to-view-documentation-in-doc-app/113866/1 "2007-09-05T19:22:44Z")

</div>

G’Day-

Noob question:

I’m currently working through the examples in Agile Development With  
Rails. On page 182, the book shows you how to generate documentation  
for your application using RDoc.

I’ve done that successfully, but the problem I’m having is that I  
can’t seem to view the documentation.

Is there a command to run?

I’ve tried pointing a browser to  
[http://localhost:3000/doc/app/index.html](http://localhost:3000/doc/app/index.html)  
to no avail.

Any ideas?

Thanks,

---

<div class="post-metadata">

**Author:** ![bezerker](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/3da27b/32.png) [@bezerker](https://www.ruby-forum.com/u/bezerker)\
**Post date:** [September 5, 2007, 7:41pm UTC](https://www.ruby-forum.com/t/how-to-view-documentation-in-doc-app/113866/2 "2007-09-05T19:41:48Z")

</div>

Hello,

The documentation is generated under doc/app in your rails project  
folder  
when you run rake doc:app. As far as I know, the documentation isn’t  
served  
by script/server. You probably wouldn’t want it to be anyway, because  
it  
could also be served when you deploy and then anyone could view your  
documentation and portions of your code whether you intended to release  
that  
information or not.

The easiest way to view the generated documentation is to hit file/open  
in  
your web browser and then open doc/app/index.html under your rails  
project  
folder.

-Dan

---

<div class="post-metadata">

**Author:** ![bezerker](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/b/3da27b/32.png) [@bezerker](https://www.ruby-forum.com/u/bezerker)\
**Post date:** [September 6, 2007, 6:04am UTC](https://www.ruby-forum.com/t/how-to-view-documentation-in-doc-app/113866/3 "2007-09-06T06:04:51Z")

</div>

One of the things that Arti ([arti-ar.cfcl.com](http://arti-ar.cfcl.com)) does is to make  
the RDoc-generated HTML files available via a separate server.

## -r

[http://www.cfcl.com/rdm](http://www.cfcl.com/rdm) Rich M.  
[http://www.cfcl.com/rdm/resume](http://www.cfcl.com/rdm/resume) removed\_email\_address@domain.invalid  
[http://www.cfcl.com/rdm/weblog](http://www.cfcl.com/rdm/weblog) +1 650-873-7841

Technical editing and writing, programming, and web development