How is PrimeFaces User Guide maintained?

UI Components for JSF
Post Reply
maedevo
Posts: 1
Joined: 09 Mar 2017, 19:05

17 Nov 2018, 00:01

The User Guide is obviously a huge effort, and lovingly taken care of. I quite like the format and layout, which makes it very easy to read, use, and find things. I like how regular it is, with clear highlighting of Java code and JSF code, nice headings, clear tables. I was thinking it would be nice if I ever made a library worthy of distributing to potentially distribute a document with similar traits.

Is the document maintained in a word processor, or some markup, or something else? (There was some mention of iwork.) Is there any automated process for documenting things like style classes, or events, or properties?

Thanks!

tandraschko
PrimeFaces Core Developer
Posts: 3979
Joined: 03 Dec 2010, 14:11
Location: Bavaria, DE
Contact:

17 Nov 2018, 18:50

Even i don't know it exactly but everything is created manually. Very likely iwork.

The community is just creating issues in github for the documentation and they will be fixed for the upcoming release.

It would be a great step to migrate to another format someday, so the community can maintain it directly.
Thomas Andraschko

PrimeFaces | PrimeFaces Extensions

Apache Member | OpenWebBeans, DeltaSpike, MyFaces, BVal, TomEE

Sponsor me: https://github.com/sponsors/tandraschko
Blog: http://tandraschko.blogspot.de/
Twitter: https://twitter.com/TAndraschko

Post Reply

Return to “PrimeFaces”

  • Information
  • Who is online

    Users browsing this forum: No registered users and 48 guests