pyr0ball
2dda26a911
Closes #15, #22, #24, #25. Closes #1 and #27 (already shipped in 0.2.0). ## CI/CD (#22) - .forgejo/workflows/ci.yml — Python lint (ruff) + pytest + Vue typecheck + vitest on every PR/push. Installs cf-core from GitHub mirror for the CI runner. - .forgejo/workflows/release.yml — Docker build/push (api + web) to Forgejo registry on v* tags; git-cliff changelog; multi-arch amd64+arm64. - .forgejo/workflows/mirror.yml — push to GitHub + Codeberg mirrors. ## Self-hosted installer (#25) - install.sh rewritten to match CF installer pattern: coloured output, named functions, --docker / --bare-metal / --help flags, auto-detect Docker/conda/ Python/Node/Chromium/Xvfb, license key prompting with format validation. ## Nginx docs (#24) - docs/nginx-self-hosted.conf — sample nginx config: SPA fallback, SSE proxy (proxy_buffering off), long-term asset cache headers. - docs/getting-started/installation.md — bare-metal install section with nginx setup, Chromium/Xvfb note, serve-ui.sh vs nginx trade-off. ## cf-orch agent (#15) - compose.override.yml — cf-orch-agent sidecar service (profiles: [orch]). Starts only with docker compose --profile orch. Registers with coordinator at CF_ORCH_COORDINATOR_URL (default 10.1.10.71:7700). - .env.example — CF_ORCH_URL / CF_ORCH_COORDINATOR_URL comments expanded. ## Docs - mkdocs.yml + full docs/ tree (getting-started, reference, user-guide) staged from prior session work. Bump version 0.2.0 → 0.3.0.
63 lines
1.8 KiB
YAML
63 lines
1.8 KiB
YAML
site_name: Snipe
|
|
site_description: eBay trust scoring before you bid — catch scammers, flag suspicious prices, surface duplicate photos.
|
|
site_author: Circuit Forge LLC
|
|
site_url: https://docs.circuitforge.tech/snipe
|
|
repo_url: https://git.opensourcesolarpunk.com/Circuit-Forge/snipe
|
|
repo_name: Circuit-Forge/snipe
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- scheme: default
|
|
primary: deep orange
|
|
accent: orange
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: deep orange
|
|
accent: orange
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Installation: getting-started/installation.md
|
|
- Quick Start: getting-started/quick-start.md
|
|
- eBay API Keys (Optional): getting-started/ebay-api.md
|
|
- User Guide:
|
|
- Searching: user-guide/searching.md
|
|
- Trust Scores: user-guide/trust-scores.md
|
|
- Red Flags: user-guide/red-flags.md
|
|
- Community Blocklist: user-guide/blocklist.md
|
|
- Settings: user-guide/settings.md
|
|
- Reference:
|
|
- Trust Score Algorithm: reference/trust-scoring.md
|
|
- Tier System: reference/tier-system.md
|
|
- Architecture: reference/architecture.md
|