docs: cut version 0.1.21
This commit is contained in:
@@ -0,0 +1,36 @@
|
||||
---
|
||||
id: documentation-style-guide
|
||||
title: Documentation Style Guide
|
||||
description: Standards for writing user-facing docs in this repository.
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
Use this structure for feature pages:
|
||||
|
||||
1. **What it is**
|
||||
2. **Why it exists**
|
||||
3. **How to use it**
|
||||
4. **Common problems**
|
||||
5. **Related pages**
|
||||
|
||||
## Frontmatter requirements
|
||||
|
||||
Every doc should include:
|
||||
|
||||
- `id`
|
||||
- `title`
|
||||
- `description`
|
||||
- `sidebar_position`
|
||||
|
||||
## Writing rules
|
||||
|
||||
- Prefer concrete steps over abstract prose.
|
||||
- Provide copy-pasteable examples.
|
||||
- State defaults and constraints explicitly.
|
||||
- Use absolute `/docs/...` URLs and include the version segment when needed.
|
||||
- For current docs, use `/docs/next/...` links.
|
||||
- For versioned docs, link within that version (for example `/docs/...` in `version-0.1.20`).
|
||||
|
||||
## PR expectations
|
||||
|
||||
Any user-visible behavior change should include matching docs updates.
|
||||
@@ -0,0 +1,30 @@
|
||||
---
|
||||
id: faq
|
||||
title: FAQ
|
||||
description: Frequently asked questions about deployment, docs, and operations.
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
## Is docs content bundled for self-hosted installs?
|
||||
|
||||
Yes. The docs static build is bundled and served locally at `/docs`.
|
||||
|
||||
## How are docs versions managed?
|
||||
|
||||
Docs are versioned using Docusaurus versions, intended to map to release tags.
|
||||
|
||||
## Where should contributors edit docs?
|
||||
|
||||
Edit files under `docs-site/docs` for latest docs.
|
||||
|
||||
## What does this cost in practice?
|
||||
|
||||
Real-world reference: from early December 2025 to mid-February 2026, with heavy usage and testing (about 10 to 15 applications per day), easily more than 3000 jobs scored, total LLM spend was about **$12 USD** using Gemini 3 Flash through OpenRouter.
|
||||
|
||||
Cost varies by:
|
||||
|
||||
- selected model/provider
|
||||
- prompt volume and size
|
||||
- number of jobs scored/tailored per run
|
||||
|
||||
For this workload, Gemini 3 Flash has been low-cost while still producing high-quality outputs.
|
||||
Reference in New Issue
Block a user