diff options
| author | Jeff Dean <jeff@zilkey.com> | 2008-11-16 22:27:08 -0500 |
|---|---|---|
| committer | Jeff Dean <jeff@zilkey.com> | 2008-11-16 22:27:08 -0500 |
| commit | 6b8500ce48f45f18696f6215b8a01f5cf0e328b5 (patch) | |
| tree | 4782b14efb504f867a5098c810c0e4236fb69485 /railties/doc/guides/source/creating_plugins/rdoc.txt | |
| parent | 097b4678f6d52e86a9d46ba6c862e6eb6ef7bbdd (diff) | |
| download | rails-6b8500ce48f45f18696f6215b8a01f5cf0e328b5.tar.gz rails-6b8500ce48f45f18696f6215b8a01f5cf0e328b5.tar.bz2 rails-6b8500ce48f45f18696f6215b8a01f5cf0e328b5.zip | |
Rails guide: Added PluginGem section, reorganized the odds and ends.
Diffstat (limited to 'railties/doc/guides/source/creating_plugins/rdoc.txt')
| -rw-r--r-- | railties/doc/guides/source/creating_plugins/rdoc.txt | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/railties/doc/guides/source/creating_plugins/rdoc.txt b/railties/doc/guides/source/creating_plugins/rdoc.txt new file mode 100644 index 0000000000..0f6f843c42 --- /dev/null +++ b/railties/doc/guides/source/creating_plugins/rdoc.txt @@ -0,0 +1,18 @@ +== RDoc Documentation == + +Once your plugin is stable and you are ready to deploy do everyone else a favor and document it! Luckily, writing documentation for your plugin is easy. + +The first step is to update the README file with detailed information about how to use your plugin. A few key things to include are: + + * Your name + * How to install + * How to add the functionality to the app (several examples of common use cases) + * Warning, gotchas or tips that might help save users time + +Once your README is solid, go through and add rdoc comments to all of the methods that developers will use. It's also customary to add '#:nodoc:' comments to those parts of the code that are not part of the public api. + +Once your comments are good to go, navigate to your plugin directory and run: + +--------------------------------------------------------- +rake rdoc +--------------------------------------------------------- |