diff options
| author | Pratik Naik <pratiknaik@gmail.com> | 2009-02-03 22:58:43 +0000 |
|---|---|---|
| committer | Pratik Naik <pratiknaik@gmail.com> | 2009-02-03 22:58:43 +0000 |
| commit | e4094e23f9e3740599e9eaac527fbef86ff4b4c4 (patch) | |
| tree | 3f0ccba263b217a513ed7ad98d68138a850013a5 /railties/doc/guides/source/creating_plugins/rdoc.txt | |
| parent | c0eeb9f1e20af2a5c4f77c71fd1236e6c1584f05 (diff) | |
| download | rails-e4094e23f9e3740599e9eaac527fbef86ff4b4c4.tar.gz rails-e4094e23f9e3740599e9eaac527fbef86ff4b4c4.tar.bz2 rails-e4094e23f9e3740599e9eaac527fbef86ff4b4c4.zip | |
Remove all the guides
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, 0 insertions, 18 deletions
diff --git a/railties/doc/guides/source/creating_plugins/rdoc.txt b/railties/doc/guides/source/creating_plugins/rdoc.txt deleted file mode 100644 index 0f6f843c42..0000000000 --- a/railties/doc/guides/source/creating_plugins/rdoc.txt +++ /dev/null @@ -1,18 +0,0 @@ -== 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 ---------------------------------------------------------- |