Skip to content

Commit 1bf4261

Browse files
committed
Fix docs links for Pages build
1 parent 83f7bf2 commit 1bf4261

File tree

2 files changed

+2
-16
lines changed

2 files changed

+2
-16
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- name: Install MkDocs
2727
run: |
2828
python -m pip install --upgrade pip
29-
pip install mkdocs mkdocs-material
29+
pip install 'mkdocs<2' 'mkdocs-material<10'
3030
3131
- name: Build site
3232
run: mkdocs build --strict

docs/index.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,15 @@ Welcome to the refreshed docs for GlossAPI, the GFOSS pipeline for turning acade
77
- [Quickstart Recipes](quickstart.md) — common extraction/OCR flows in copy-paste form.
88
- [Lightweight PDF Corpus](lightweight_corpus.md) — 20 one-page PDFs for smoke testing without Docling or GPUs.
99

10-
## Understand the architecture
11-
- [Architecture Overview](architecture/index.md) — the end-to-end staged model and why it exists.
12-
- [Core Design Principles](architecture/core_design_principles.md) — the design constraints that shape the pipeline.
13-
- [Docling Throughput and Batching](architecture/docling_throughput_and_batching.md) — how throughput and stability trade off.
14-
- [Failure Recovery and Skiplist](architecture/docling_failure_recovery_and_skiplist.md) — how the pipeline survives problematic PDFs.
15-
- [Greek Text Validation](architecture/greek_text_validation.md) — why extraction success is not enough for Greek corpora.
16-
- [Metadata, Artifacts, and Run Diagnostics](architecture/metadata_artifacts_and_run_diagnostics.md) — how provenance and operational state are retained.
17-
- [Artifact Layout and Stage Handoffs](architecture/artifact_layout_and_stage_handoffs.md) — how folders, filenames, and metadata glue the stages together.
18-
- [Resumability, Recovery, and Retention](architecture/resumability_recovery_and_retention.md) — how the current design supports reruns and where storage pressure appears.
19-
- [DeepSeek-Only Upgrade Roadmap](architecture/deepseek_only_upgrade_roadmap.md) — the staged simplification plan for OCR and dependency upgrades.
20-
2110
## Learn the pipeline
2211
- [Pipeline Overview](pipeline.md) explains each stage and the emitted artifacts.
2312
- [OCR & Math Enrichment](ocr_and_math_enhancement.md) covers DeepSeek OCR remediation and Docling-based enrichment.
2413
- [Multi-GPU & Benchmarking](multi_gpu.md) shares scaling and scheduling tips.
25-
- [Stage Reference](stages/index.md) breaks down each pipeline stage as a contract.
2614

2715
## Configure and debug
2816
- [Configuration](configuration.md) lists all environment knobs.
2917
- [Troubleshooting](troubleshooting.md) captures the most common pitfalls.
3018
- [AWS Job Distribution](aws_job_distribution.md) describes large-scale scheduling.
31-
- [Compatibility And Regression Matrix](testing/compatibility_matrix.md) defines the release-validation gates for the migration and upgrades.
3219

3320
## Reference
34-
- [Corpus API](api/corpus.md) details public methods and parameters.
35-
- `docs/divio/` contains placeholder pages for the upcoming Divio restructuring—feel free to open PRs fleshing them out.
21+
- [Corpus API](api_corpus_tmp.md) details public methods and parameters.

0 commit comments

Comments
 (0)