bearomorphism opened a new pull request, #1307:
URL: https://github.com/apache/mahout/pull/1307

   ## What
   
   Slice (A) from #1285 (per the [status 
comment](https://github.com/apache/mahout/issues/1285#issuecomment-4414370356)).
 `qdp/docs/readers/README.md` referenced `../ADDING_INPUT_FORMATS.md` in two 
places, but that file has never existed. `lychee.toml` carried an explicit 
exclude with a `TODO: fix the links in this file` note because of these.
   
   ## Why
   
   - The link checker had to ignore the entire file to keep CI green, hiding 
any future link rot in this README.
   - Readers landing on the page see a 404-shaped reference for the "extension 
guide".
   - The published doc on the same topic (`docs/qdp/readers.md`) had already 
chosen the right pattern for this — a plain-text `ADDING_INPUT_FORMATS.md 
(TODO)` marker — so the in-source README was the inconsistent one.
   
   ## How
   
   - **`qdp/docs/readers/README.md`** — replace the two dead 
`[../ADDING_INPUT_FORMATS.md](../ADDING_INPUT_FORMATS.md)` markdown links with 
`` `ADDING_INPUT_FORMATS.md` (TODO) `` plain text, matching 
`docs/qdp/readers.md` lines 142 and 226. The placeholder remains visible to 
anyone who wants to write the extension guide later, but is no longer a broken 
link.
   - **`lychee.toml`** — drop `./qdp/docs/readers/README.md` from 
`exclude_path` (and its `TODO: fix the links in this file` comment) so CI's 
link checker covers the file again.
   
   Out of scope (left to @ryankert01 or follow-ups):
   - Writing the actual `ADDING_INPUT_FORMATS.md` content.
   - Reconciling `docs/qdp/readers.md` ↔ `qdp/docs/readers/README.md` 
duplication / "File Organization" stale tree.
   - Other #1285 sub-tasks (migration docs, more examples).
   
   ## Verification
   
   Reproduced and verified locally with `lychee 0.24.2`.
   
   **Before:**
   
   ``````
   $ lychee qdp/docs/readers/README.md
   [ERROR] file:///…/qdp/docs/ADDING_INPUT_FORMATS.md (at 137:5) | File not 
found
   [ERROR] file:///…/qdp/docs/ADDING_INPUT_FORMATS.md (at 221:25) | File not 
found
   🔍 2 Total ✅ 0 OK 🚫 2 Errors
   ``````
   
   **After (with project config so the new exclude_path is honoured):**
   
   ``````
   $ lychee --config lychee.toml qdp/docs/readers/README.md
   🔍 0 Total ✅ 0 OK 🚫 0 Errors
   ``````
   
   (0 total because the only links in this file were the broken ones; the 
rewritten markers are now plain text. Nothing else in the README points 
outward.)
   
   Pre-commit (`end-of-file-fixer`, `trailing-whitespace`) passes on the 
changed files.
   
   Refs #1285
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to