Fix broken links: repair PDF CI/CD pipeline and fix FEATURE_COMPARISON.md reference#218
Fix broken links: repair PDF CI/CD pipeline and fix FEATURE_COMPARISON.md reference#218
Conversation
Adding CLAUDE.md with task information for AI processing. This file will be removed when the task is complete. Issue: #217
Fixes #217 **Broken links fixed:** 1. `README.ru.md`: Removed dead link to `FEATURE_COMPARISON.md` (deleted in commit 1ee4eca). Replaced with link to existing `TEST_CASE_COMPARISON.md`, consistent with the English `README.md`. 2. `README.md`, `README.ru.md`, `docs/website/index.html`, `docs/website/dist/index.html`: Removed broken PDF link `Link.Foundation.Links.Notation.pdf` which never existed on GitHub Pages. In `docs/website/*.html`: replaced with working C# API documentation link. **Root cause analysis:** - `FEATURE_COMPARISON.md` was intentionally deleted in Nov 2025 but the Russian README was not updated consistently. - The PDF (`Link.Foundation.Links.Notation.pdf`) was never deployed to GitHub Pages after the repository migration from `linksplatform/Protocols.Lino` to `link-foundation/links-notation`. The PDF generation script uses `Platform.$REPOSITORY_NAME.pdf` naming which doesn't match the new C# namespace, and the generated artifact is not shared with the documentation deployment job. **Case study:** Added comprehensive root cause analysis at `docs/case-studies/issue-217/README.md` with: - Full timeline of events for both broken links - CI log evidence (saved to `docs/case-studies/issue-217/ci-logs/`) - Proposed short-term and long-term solutions Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This reverts commit 9b8a04e.
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
Now working session is ended, feel free to review and add any feedback on the solution draft. |
✅ Ready to mergeThis pull request is now ready to be merged:
Monitored by hive-mind with --auto-restart-until-mergeable flag |
|
Instead of removing |
|
🤖 AI Work Session Started Starting automated work session at 2026-02-27T13:22:15.606Z The PR has been converted to draft mode while work is in progress. This comment marks the beginning of an AI work session. Please wait for the session to finish, and provide your feedback. |
…otation.pdf Implements the full fix for broken PDF documentation link (#217): 1. Fix path resolution in format-csharp-document.sh: - Patch `./csharp/Platform.$REPOSITORY_NAME` references to use `./Link.Foundation.Links.Notation` (the actual project directory) 2. Fix PDF output filename in generate-csharp-pdf.sh: - Patch output to produce `Link.Foundation.Links.Notation.pdf` instead of `Platform.links-notation.pdf` 3. Add artifact sharing between CI jobs: - Upload PDF as `csharp-pdf` artifact after generatePdfWithCode - Download artifact in publishDocumentation job - Copy PDF into `_site/` after DocFX generates documentation 4. Restore PDF documentation links: - README.md, README.ru.md, docs/website/index.html, docs/website/dist/index.html Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
🤖 Solution Draft LogThis log file contains the complete execution trace of the AI solution draft process. 💰 Cost estimation:
Now working session is ended, feel free to review and add any feedback on the solution draft. |
Summary
Fixes #217 — Two broken links found in project documentation.
Root Cause Analysis
Broken Link 1:
FEATURE_COMPARISON.mdRoot cause: Inconsistent update when deleting the file.
FEATURE_COMPARISON.mdwas created Sep 10, 2025 (commit `a3ea131`) as a comparison of YAML/XML/JSON/LINO formatsFix: Updated `README.ru.md` to link to `TEST_CASE_COMPARISON.md` (consistent with `README.md`).
Broken Link 2: `Link.Foundation.Links.Notation.pdf`
Root cause: Three compounding problems in the CI/CD pipeline:
Evidence from CI run `20053077913` (2025-12-09):
```
find: './csharp/Platform.links-notation': No such file or directory
```
Fix: Repaired the entire PDF pipeline in `.github/workflows/csharp.yml`:
Files Changed
Case Study
Full root cause analysis is documented at `docs/case-studies/issue-217/README.md`.