~/blog/docs

Documentation

Notes and policies for the blog — how the publishing API is reached, what it returns, and what it stores.

Getting Started

A short introduction to the blog: what it serves, how its routes are organised, and where to look first if you are reading the code.

/blog/docs/getting-started

Docs README

How the documentation folder is organised, how each markdown file becomes a page, and where to add a new one.

/blog/docs/readme

Authentication

How the blog's admin endpoints are authenticated: the x-admin-token header, what a missing or wrong token returns, and why it is 401 rather than 403.

/blog/docs/authentication

Security

The security posture of the blog: response headers, the content security policy, rate limiting, and how to report something you have found.

/blog/docs/security

Privacy

The technical side of what the blog records: hashed IP addresses, aggregate route counts, log retention, and the one contact channel for a deletion request.

/blog/docs/privacy

Terms

The terms under which the writing on the blog is published and may be quoted, and the limits of any warranty on the code it describes.

/blog/docs/terms

Rate Limits

The rate limits applied to the blog, which request methods they cover, and what a client should do when it receives a 429 response.

/blog/docs/rate-limits

Errors

The error responses the blog returns, what each status code means in practice, and which of them are safe for a client to retry.

/blog/docs/errors