[ 
https://issues.apache.org/jira/browse/PDFBOX-3030?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14959524#comment-14959524
 ] 

John Hewson commented on PDFBOX-3030:
-------------------------------------

I'm not sure about the "Cookbook". Examples which don't compile when copy + 
pasted are not particularly helpful. I say this as somebody who learned PDFBox 
myself only a couple of years ago - the cookbook was not a good resource, being 
as it is a mix of not enough details (code doesn't compile) and too many 
irrelevant details.

I'd argue for retiring the cookbook in 2.0 and focusing instead on examples 
which are part of our o.a.p.examples module and actually compile. We can link 
to them from the Examples section of the 2.0 website, providing a summary of 
each example etc, rather than just the single link which is there currently.

> Enhance documentation for PDFBox 2.0.0
> --------------------------------------
>
>                 Key: PDFBOX-3030
>                 URL: https://issues.apache.org/jira/browse/PDFBOX-3030
>             Project: PDFBox
>          Issue Type: Task
>          Components: Documentation
>    Affects Versions: 2.0.0
>            Reporter: Maruan Sahyoun
>            Assignee: Maruan Sahyoun
>
> Task to track enhancements to the documentation or website as part of PDFBox 
> 2.0.0
> - update javadoc (current as of writing)
> - migration guide 



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to