Skip to content

writechoiceorg/Technical-Writing-Test-TaskFlow-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

Technical Writing Test — TaskFlow API

Overview

Your task is to create public-facing documentation for TaskFlow, a simple task management API.

You will receive an OpenAPI spec file (openapi.yaml) and access to a live API. Your job is to turn these into clear, well-structured, and published documentation using Mintlify.

There is no single correct answer for how the documentation should be structured. Part of what we are evaluating is how you think about what a reader needs — and how far you take the work.


What you need to produce

  • A Mintlify documentation project, set up from scratch and deployed as a live public URL
  • API Reference pages for all endpoints, based on the provided OpenAPI spec
  • Supporting documentation — beyond the endpoint reference itself

What the supporting documentation looks like, how many pages it has, and how it is organized is up to you.


What you need

  • openapi.yaml: the full API specification available in this repository
  • Live API base URL: https://test-writechoice.onrender.com/ use this to test the API
  • API key: tf-live-4a8f2c1e9b3d7e6a use this to test the API

Important: The API may take up to 60 seconds to respond on the first request if it has been idle. This is expected behavior.


How to authenticate

All requests to the API require the following header:

Authorization: Bearer tf-live-4a8f2c1e9b3d7e6a

Submission

Send the following two links before the deadline:

  1. Live Mintlify URL — the published documentation site
  2. GitHub repository URL — the source code for your Mintlify project

Along with the links, include a short written summary (no specific format or length required) describing:

  • The process you followed to complete the task
  • Any decisions you made about structure or content, and why
  • Anything you found challenging or would do differently with more time

Deadline

You have two full days from the moment you receive this brief.


Notes

  • Read the OpenAPI spec carefully before you start writing. Test the live endpoints.
  • Mintlify has documentation at mintlify.com/docs. You will need to create a free account.
  • If you run into a blocker, make a note of it in your summary rather than stopping.
  • There are no restrictions on tools you can use.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors