From 7d1b1319bec17727ef46632735faeea11fecc53d Mon Sep 17 00:00:00 2001 From: pyr0ball Date: Mon, 18 May 2026 12:05:03 -0700 Subject: [PATCH] docs: fix repo URLs and clarify BYOK tier unlocking in feature matrix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace git.circuitforge.io/circuitforge/peregrine with the correct Forgejo URL (git.opensourcesolarpunk.com/Circuit-Forge/peregrine) in Quick Start, License, and Contributing clone instructions. Update feature matrix in docs/index.md to show BYOK‡ for AI features (cover letter, company research, interview prep, survey assistant) with a footnote explaining the free-with-own-backend model. Previously the table showed these as Paid-only, which would mislead self-hosters. --- docs/developer-guide/contributing.md | 2 +- docs/index.md | 21 ++++++++++++--------- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/developer-guide/contributing.md b/docs/developer-guide/contributing.md index e4d6261..2d28cf1 100644 --- a/docs/developer-guide/contributing.md +++ b/docs/developer-guide/contributing.md @@ -11,7 +11,7 @@ Thank you for your interest in contributing to Peregrine. This guide covers the ## Fork and Clone ```bash -git clone https://git.circuitforge.io/circuitforge/peregrine +git clone https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine cd peregrine ``` diff --git a/docs/index.md b/docs/index.md index e684cbe..cdf5ba7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,7 +12,7 @@ Peregrine automates the full job search lifecycle: discovery, matching, cover le ```bash # 1. Clone and install dependencies -git clone https://git.circuitforge.io/circuitforge/peregrine +git clone https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine cd peregrine bash install.sh @@ -31,20 +31,23 @@ The first-run wizard guides you through hardware detection, tier selection, iden ## Feature Overview -| Feature | Free | Paid | Premium | -|---------|------|------|---------| +| Feature | Free | Paid† | Premium | +|---------|------|-------|---------| | Job discovery (JobSpy + custom boards) | Yes | Yes | Yes | | Resume keyword matching | Yes | Yes | Yes | -| Cover letter generation | - | Yes | Yes | -| Company research briefs | - | Yes | Yes | -| Interview prep & practice Q&A | - | Yes | Yes | +| Cover letter generation | BYOK‡ | Yes | Yes | +| Company research briefs | BYOK‡ | Yes | Yes | +| Interview prep & practice Q&A | BYOK‡ | Yes | Yes | | Email sync & auto-classification | - | Yes | Yes | -| Survey assistant (culture-fit Q&A) | - | Yes | Yes | +| Survey assistant (culture-fit Q&A) | BYOK‡ | Yes | Yes | | Integration connectors (Notion, Airtable, etc.) | Partial | Yes | Yes | | Calendar sync (Google, Apple) | - | Yes | Yes | | Cover letter model fine-tuning | - | - | Yes | | Multi-user support | - | - | Yes | +† **Paid** gives access to CircuitForge's hosted inference — no API key required. +‡ **BYOK** — configure any LLM backend in `config/llm.yaml` (local Ollama/vLLM or an API key) and these features unlock at no charge, regardless of tier. + See [Tier System](reference/tier-system.md) for the full feature gate table. --- @@ -60,8 +63,8 @@ See [Tier System](reference/tier-system.md) for the full feature gate table. ## License -Core discovery pipeline: [MIT](https://git.circuitforge.io/circuitforge/peregrine/src/branch/main/LICENSE-MIT) +Core discovery pipeline: [MIT](https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine/src/branch/main/LICENSE-MIT) -AI features (cover letter generation, company research, interview prep, UI): [BSL 1.1](https://git.circuitforge.io/circuitforge/peregrine/src/branch/main/LICENSE-BSL) +AI features (cover letter generation, company research, interview prep, UI): [BSL 1.1](https://git.opensourcesolarpunk.com/Circuit-Forge/peregrine/src/branch/main/LICENSE-BSL) © 2026 Circuit Forge LLC