Kition
noteTechnical Writing

Parcel Tracking API Reference

Developer documentation for a small REST API, with request and response code fences, parameter and error tables, and an anchor link to the errors section.

Parcel Tracking API Reference — Note sample rendered by Kition

Reference pages are mostly code and tables: an HTTP request, a JSON response and a curl example in fenced blocks with their languages, a parameter table with aligned columns (`table.align` right-aligns the limits column afterwards), and an error table that the text links to with a same-note anchor (`[[#Errors]]`), which the kit's check resolves.

Steps

5 commands
showcase.yaml55 lines
steps:
  - command: note.write
    params:
      markdown: |
        # Parcel Tracking API

        Version 2 · Base URL `https://api.parcelpost.example/v2` · All responses are JSON. Failures use the codes listed under [[#Errors]].

        ## Get a parcel

        ```http
        GET /parcels/{tracking_id}?events=10
        Authorization: Bearer <token>
        ```

        | Parameter | In | Type | Limit |
        | --- | --- | --- | --- |
        | `tracking_id` | path | string | 12 to 20 chars |
        | `events` | query | integer | 1 to 50 |
        | `lang` | query | string | 2 letters |

        ### Response

        ```json
        {
          "tracking_id": "PP4471920583GB",
          "status": "out_for_delivery",
          "eta": "2026-11-10T14:00:00Z",
          "events": [
            { "at": "2026-11-10T06:12:00Z", "place": "Leeds depot", "code": "OFD" }
          ]
        }
        ```

        ### Example

        ```sh
        curl -H "Authorization: Bearer $TOKEN" \
          https://api.parcelpost.example/v2/parcels/PP4471920583GB
        ```

        ## Errors

        | Status | Code | When |
        | --- | --- | --- |
        | 401 | `auth_missing` | No or expired token |
        | 404 | `not_found` | Unknown tracking id |
        | 429 | `rate_limited` | Over 60 requests a minute |

        > [!NOTE] Rate limits
        > The `Retry-After` header says how many seconds to wait.
  - { command: table.align, params: { table: 0, column: 3, align: right } }
  - { command: table.align, params: { table: 1, column: 0, align: center } }
  - { command: table.read, params: { table: 0 }, as: params }
  - { command: links.list, params: { kinds: [wikilink] }, as: anchors }

Checks

7 checks on every build
  • inspect.heading = "Parcel Tracking API"
  • inspect.headings = 5
  • inspect.tables = [{"columns":4,"rows":4},{"columns":3,"rows":4}]
  • results.params.align = ["none","none","none","right"]
  • results.anchors.links = {"count":1,"all":{"anchor":"#Errors"}}
  • Diagnostics: none, the kit's own check finds nothing wrong
  • The saved document opens again, and its thumbnail matches thumb.png within the render tolerance

Related

More Note samples
noteProject Docs

Tidewater Project README

An open-source project README with install and usage code blocks, a configuration table, a feature list and a contributing section added afterwards.

2 pages; 171 words; 7 headings; 1 table
noteKnowledge Base

Mechanics Revision Formulas

A revision sheet of mechanics formulas set as display and inline LaTeX math, with a worked example in a callout and a symbol table.

1 page; 134 words; 6 headings; 1 table
noteKnowledge Base

New Starter Wiki Page

A team wiki page for new starters whose contents list links to headings in the same note; one heading was renamed, so the kit's check reports the broken anchor.

1 page; 147 words; 5 headings; 1 table
noteKnowledge Base

Reading List Tracker

A year's reading list kept as a Markdown table that grows row by row, with a status column, star ratings and a short reviews section.

1 page; 102 words; 3 headings; 1 table