Skip to content

Commit 3caeec3

Browse files
authored
update with more links
1 parent 8215322 commit 3caeec3

1 file changed

Lines changed: 4 additions & 15 deletions

File tree

README.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,12 @@ Why you can have a Google Map on your Web page
4444
- http://catfacts-api.appspot.com/doc.html
4545
- http://catfacts-api.appspot.com/api/facts?number=3
4646

47-
## Details
48-
49-
### Consuming and Theory
47+
## Consuming and Theory
5048

5149
- [API Clients](docu/apiclients.md)
5250
- [API Reference](docu/apireference.md)
5351

54-
### Technical
55-
56-
Let us document our own service and publish documentation for it to a public server.
57-
58-
- [Purpose](docu/purpose.md) -> Technologies behind the whole concept
59-
- [Prerequisites](docu/prerequisites.md) -> You need to install some software on your machine first
60-
- [Set up and publishing](docu/using_docu_tool.md) -> Set up your local environment and publish first version of your documentation page
61-
- [Write a Details document](docu/newdocu.md) -> Write new document
62-
63-
### Extra tasks
52+
## Setting up a portal with REST API documentation
6453

65-
- API specification requires update in the schema for errors part -> Make some edits to API specification
66-
- Now create a automated pipeline that will pick your changes and deploy to GitHub Pages. Use https://travis-ci.org/
54+
- Do it with documentation listed in tutorial here https://github.com/YaaS/docpad-skeleton-apidocs#tutorial
55+
- Do it with video support https://www.youtube.com/watch?v=a0i6kXxgYuwdoc

0 commit comments

Comments
 (0)