8825292146
The audit reports under docs/audit/reports/release-*/ reference repo source files (e.g. `[file.py:line](file.py:line)`) on purpose — they are read with the repo open, not as standalone published pages. MkDocs in strict mode treats those as unrecognized links and aborts the build. Set `validation.links.unrecognized_links: info` so the warning still prints but doesn't fail the build. Real broken doc links (anchors, absolute paths) keep their existing levels. Refs the doc deploy run that broke just after the v0.5.0 tag was pushed.
94 lines
3.1 KiB
YAML
94 lines
3.1 KiB
YAML
site_name: Docling Studio
|
|
site_description: Visual document analysis studio powered by Docling
|
|
site_url: https://scub-france.github.io/Docling-Studio/
|
|
repo_url: https://github.com/scub-france/Docling-Studio
|
|
repo_name: scub-france/Docling-Studio
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: deep orange
|
|
accent: orange
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: deep orange
|
|
accent: orange
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Light mode
|
|
features:
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- content.code.copy
|
|
- toc.integrate
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started: getting-started.md
|
|
- Architecture: architecture.md
|
|
- Bbox Pipeline: bbox-pipeline.md
|
|
- Contributing: contributing.md
|
|
- Processes: PROCESSES.md
|
|
- Development:
|
|
- Coding Standards: architecture/coding-standards.md
|
|
- Commit Conventions: git-workflow/commit-conventions.md
|
|
- Code Review Checklist: git-workflow/code-review-checklist.md
|
|
- Merge Policy: git-workflow/merge-policy.md
|
|
- ADR Guide: architecture/adr-guide.md
|
|
- ADR Template: architecture/adr-template.md
|
|
- Release:
|
|
- Deployment Checklist: release/deployment-checklist.md
|
|
- Rollback Playbook: release/rollback-playbook.md
|
|
- Operations:
|
|
- Incident Response: operations/incident-response.md
|
|
- Security Response: operations/security-response.md
|
|
- Monitoring Checklist: operations/monitoring-checklist.md
|
|
- Community:
|
|
- Onboarding Guide: community/onboarding-guide.md
|
|
- Issue Triage: community/issue-triage-process.md
|
|
- Roadmap Template: community/roadmap-template.md
|
|
- Audit:
|
|
- Audit Master: audit/master.md
|
|
- Audits:
|
|
- Hexagonal Architecture: audit/audits/01-clean-architecture.md
|
|
- DDD: audit/audits/02-ddd.md
|
|
- Clean Code: audit/audits/03-clean-code.md
|
|
- KISS: audit/audits/04-kiss.md
|
|
- DRY: audit/audits/05-dry.md
|
|
- SOLID: audit/audits/06-solid.md
|
|
- Decoupling: audit/audits/07-decoupling.md
|
|
- Security: audit/audits/08-security.md
|
|
- Tests: audit/audits/09-tests.md
|
|
- CI & Build: audit/audits/10-ci-build.md
|
|
- Documentation: audit/audits/11-documentation.md
|
|
- Performance: audit/audits/12-performance.md
|
|
|
|
validation:
|
|
nav:
|
|
omitted_files: info
|
|
absolute_links: info
|
|
links:
|
|
absolute_links: info
|
|
# Audit reports (audit/reports/release-X.Y.Z/) reference repo source
|
|
# files (e.g. `[file.py:line](file.py:line)`) by design — they're read
|
|
# alongside the repo, not as standalone docs. Downgrade to info so
|
|
# strict-mode builds don't fail on these intentional cross-tree links.
|
|
unrecognized_links: info
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
permalink: true
|