Skip to content

Commit ada8696

Browse files
authored
Update API documentation reference to use RubyDoc (#145)
1 parent 7de87f0 commit ada8696

File tree

1 file changed

+2
-19
lines changed

1 file changed

+2
-19
lines changed

README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ gem install platform-api
2626

2727
## API documentation
2828

29-
Jump right to the [API documentation](http://heroku.github.io/platform-api/_index.html)
29+
Jump right to the [API documentation](https://www.rubydoc.info/gems/platform-api)
3030
for the nitty gritty details.
3131

3232
## Usage guide
@@ -51,7 +51,7 @@ For example, to get information about the `web` formation on the `sushi` app
5151
you'd invoke `heroku.formation.info('sushi', 'web')` and it would return a
5252
Ruby object that matches the one given in the [response example](https://devcenter.heroku.com/articles/platform-api-reference#formation-info).
5353

54-
The [API documentation](http://heroku.github.io/platform-api/_index.html) contains a
54+
The [API documentation](https://www.rubydoc.info/gems/platform-api) contains a
5555
description of all available resources and methods.
5656

5757
### Handling errors
@@ -370,23 +370,6 @@ Remember to commit and push the changes to Github.
370370
* `git commit -m 'vX.Y.Z' to stage the version and Gemfile.lock changes
371371
* `rake release` to push git changes and to release to Rubygems
372372

373-
### Building API documentation
374-
375-
Build documentation with:
376-
377-
```
378-
rake yard
379-
```
380-
381-
And then visit `doc/index.html` to read it. Alternately, build and publish
382-
it to Github Pages in one step with:
383-
384-
```
385-
rake publish_docs
386-
```
387-
388-
You can see it live on [Github Pages](http://heroku.github.io/platform-api/).
389-
390373
## Contributing
391374

392375
1. [Fork the repository](https://github.com/heroku/platform-api/fork).

0 commit comments

Comments
 (0)