Tutorials

Tutorials in Shaf are learning-oriented lessons designed to guide you step-by-step from zero knowledge to confident mastery. Whether you are shortening your first edge link or automating link deployment through CI/CD pipelines, each lesson provides a safe, guided sandbox with immediate, tangible results.

The Learning Journey

Our curriculum is structured into four progressive stages. Each tutorial builds directly upon the skills acquired in the previous step:

123[Level 1: Quickstart] ──> [Level 2: Custom Domains] ──> [Level 3: Team Workspaces] ──> [Level 4: REST API]
     (⏱ 3 min)                  (⏱ 5 min)                     (⏱ 4 min)                   (⏱ 6 min)
First link & analytics       Branded DNS & Auto TLS          Workspaces & RBAC           API Keys & Automation

Before You Begin: All tutorials can be completed with a free Shaf account. No credit card is required. You will only need access to a modern web browser, and for Level 4, a terminal with curl or Node.js/Python.

Available Lessons

1. Quickstart: First Branded Link

Level 1 • ⏱ 3 min • Beginner

Sign in, create an edge-routed short link with a custom slug, generate a vector QR code, and inspect real-time click analytics.

You will build: A live, working edge short link (shaf.is/edge-guide)
Key skills: Slug customization, QR codes, edge redirect verification, real-time analytics

2. Connecting Your Custom Domain

Level 2 • ⏱ 5 min • Intermediate

Connect your own domain (e.g. link.yourbrand.com), configure DNS CNAME records at your registrar, and verify zero-config SSL certificates.

You will build: A fully branded custom domain with automated TLS termination
Key skills: DNS CNAME configuration, registrar routing, SSL lifecycle, fallback redirects

3. Team Collaboration & Workspaces

Level 3 • ⏱ 4 min • Intermediate

Provision isolated organization workspaces, invite teammates via transactional email, and enforce Role-Based Access Control (RBAC).

You will build: A multi-tenant workspace with isolated links, domains, and quotas
Key skills: Workspace provisioning, email invitations, RBAC tiers (Owner, Admin, Member)

4. Making Your First API Request

Level 4 • ⏱ 6 min • Developer

Generate a scoped developer API token, construct authenticated HTTP requests, and programmatically create links and query metrics.

You will build: An automated script creating links and extracting analytics
Key skills: API authentication, JSON payloads, error handling, programmatic analytics

Curriculum Overview & Deliverables

Level	Tutorial	Target Audience	Time	Production Deliverable
1	Quickstart	Anyone new to Shaf	3 min	Live short link on `shaf.is` with real-time analytics
2	Custom Domain	Domain admins & marketers	5 min	Verified custom subdomain with auto-renewing TLS
3	Team Workspaces	Team leads & agencies	4 min	Collaborative workspace with RBAC roles configured
4	First API Request	Developers & DevOps	6 min	Authenticated code script creating & monitoring links

When to Use Tutorials vs Other Sections

Tutorials (You are here): Step-by-step lessons focused on acquiring basic competence as a newcomer.
How-To Guides: Practical recipes to solve specific real-world problems (e.g. "How to import links from Bitly", "How to configure geo-targeting").
Reference: Technical descriptions, schema specifications, and REST API contracts.
Explanation: High-level architectural discussions explaining why Shaf works the way it does.

Ask AI about this page