slachiewicz opened a new pull request, #1358:
URL: https://github.com/apache/maven-javadoc-plugin/pull/1358

   Part of an estate-wide move of the remaining FAQ pages from FML to Markdown. 
This repo is one of three pilots.
   
   ### Two commits, deliberately
   
   1. **A pure rename**, `src/site/fml/faq.fml` -> `src/site/markdown/faq.md`, 
no content change.
   2. **The rewrite**, written by hand.
   
   Git records a rename plus a rewrite in a single commit as a delete and an 
add, which stops `git log --follow`. Splitting them keeps the history. **Please 
merge or rebase rather than squash.**
   
   ### Anchors are preserved, and that is the point
   
   These pages have been on maven.apache.org for years and are linked from 
outside. FML derives its anchor from the `<faq id=...>` attribute, and where 
that attribute is not a valid XML name `DoxiaUtils.encodeId` rewrites it at 
render time. The `<a name>` elements written here reproduce **the anchor the 
live site serves today**, not the raw attribute.
   
   ### Verification
   
   Built the site before and after and compared the set of anchors the 
generated `faq.html` actually serves. Requirement: every anchor served before 
must still be served after.
   
   ### What is lost
   
   FML generates a `[top]` back-link after each answer. Those are dropped 
rather than hand-written. The question becomes an `h3` heading instead of a 
definition term. Nothing else changes.
   
   <sub>Drafted with Claude — please verify</sub>
   
   **This repo:** the largest FAQ in the estate at 16 questions, and every one 
of its anchors is an encodeId-rewritten form — none of the 16 `id=` values is a 
valid XML name. For example `id="What are the values of the encoding, 
docencoding, and charset parameters"` is served as 
`#What_are_the_values_of_the_encoding.2C_docencoding.2C_and_charset_parameters`.
 All 16 plus `#top` verified preserved; `<head>` byte-identical; every link 
target on the page unchanged.


-- 
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