Autogenerate "user" docs about "plugins" from code
--------------------------------------------------
Key: SOLR-555
URL: https://issues.apache.org/jira/browse/SOLR-555
Project: Solr
Issue Type: Improvement
Reporter: Hoss Man
Assignee: Hoss Man
Our current strategy of using javadocs for "developer" documentation and the
wiki for documenting "user" features only gets us so far -- among other things,
it makes it hard to include the "user" documentation in our releases, but it
also results in a disconnect between when code changes and when documentation
gets updated.
in an ideal world, "user" documentation would live in the code right along side
the implementation, just like with javadocs -- but the standard set of
information displayed by javadocs isn't very user friendly. we should find a
better way to allow us to "edit" the info about how to use a plugin right along
side the code for that plugin and generate user friendly documentation from
that.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
