Docs
Documentation for calm, developer-first tools & APIs.
Birdor Docs is the home for reference guides, how-tos, and architecture notes around Birdor tools, APIs, and patterns. The goal is simple: help you understand how things work, without making you dig.
As Birdor grows, this page will become the entry point into a small, well-organized documentation space — more handbook than marketing site.
Start here
A quick map of the documentation if you’re just getting familiar with Birdor.
Guide
What is Birdor?
Birdor is a calm, developer-first hub of browser tools, docs, and engineering notes. Everything is built to be predictable, privacy-friendly, and easy to keep open next to your editor.
Tools
Tool Guides
Short, focused guides for each Birdor tool: what it does, how it works internally, and common usage patterns for everyday debugging.
Changelog
What changed recently?
A small, honest changelog that records tool updates, docs improvements, and infrastructure changes — no hype, just clear notes.
Getting started (for now)
Even while the full docs space is under construction, there are a few good places to start.
What can I do with Birdor?
- Explore existing tools on the Tools page.
- Read architecture and deep-dive posts on blog.birdor.com.
- Check the Birdor GitHub org for open-source examples and templates.
As APIs and more advanced features go live, they'll be documented here first, with clear “copy this into your code” examples.
Documentation style & philosophy
A few simple rules that guide how Birdor Docs are written.
Writing style
- Explain concepts before showing complex configuration.
- Prefer small, complete examples over abstract pseudo-code.
- Call out trade-offs honestly and explicitly.
- Assume the reader is smart, but busy.
- Keep tone calm, friendly, and practical.
The goal is not just to help you "make it work", but to help you understand why it works — so you can confidently build on top of it.
Documentation structure
Birdor Docs is organized into a few clear sections as it grows.
1. Tool Guides
Short, focused guides for each Birdor tool, including JSON, JWT, URLs, encoding, hashing, IDs, and more.
- What the tool does and when to use it.
- How it works internally, at a high level.
- Common usage patterns and edge cases.
2. API Reference
A precise, copy-paste-friendly reference for future Birdor APIs.
- Request / response formats and examples.
- Rate limits, error handling, and retries.
- Authentication and API key management.
- Language snippets (cURL, JS/TS, Go, ...).
3. How-tos
Longer-form, scenario-based guides around Birdor in practice.
- Using Birdor tools in day-to-day development.
- Integrating Birdor APIs into small SaaS projects.
- Running Birdor alongside Next.js & Cloudflare.
- Debugging common problems with real examples.
4. Concepts & Architecture
Deeper explanations when you want to understand the “why”.
- Birdor's approach to privacy & client-side tools.
- Multi-tenant patterns and isolation.
- Cost-aware infrastructure & rate limiting.
- Design principles for calm developer tools.
Help shape Birdor Docs
Docs are never really 'finished' — that’s a feature, not a bug.
Feedback
If there's a guide you'd like to see, an API you want clarified, or a concept that feels under-explained:
- Open an issue or discussion on GitHub.
- Or email contact@birdor.com.
Birdor is built for developers — and the documentation will grow alongside the people who use it.