Interledger Technical Test for the Technical Writer Role
This challenge is intended to be done at home. You have three days to complete it.
We've purposefully kept instructions to a minimum. After we review your submission, we'll schedule a video call where we can discuss your choices and deliverables.
Document the icanhazdadjoke REST API by creating the following resources:
- An overview (no more than a single page) that outlines the concepts and functionality of the API
- An OpenAPI specification for the “Search for dad jokes” endpoint
- A 500 - 1,000 word step-by-step tutorial for using the API endpoint in the programming language of your choice
Note that the API has no authentication requirements, supports multiple response formats, and requires a user agent.
You can use any resources you like. You are encouraged to use any libraries that you find helpful.
Please do not share this challenge or your solution to it with others.
- The documentation set must be written in Markdown.
- You must use a static site generator to render the documentation. If you need a place to host your content, GitHub Pages allows you to serve a static website directly from your repository.
$curl -H "Accept: application/json" -H "User-Agent: ILF Test (https://github.com/username/repo)" https://icanhazdadjoke.com/search