Fixes to ChangeApplier docs - Githubissues

fluid-project / infusion-docs

Documentation space for Infusion

http://docs.fluidproject.org/infusion

Creative Commons Attribution 4.0 International

8 stars 45 forks source link

Fixes to ChangeApplier docs #295

Open jobara opened 1 month ago

jobara commented 1 month ago

Some issues were found with the ChangeApplier.html and ChangeApplierAPI.html pages:

ChangeApplier.html:

"model state" link goes to Framework Concepts page, but not immediately clear what the user should read from there. "Model state" isn't even mentioned on the Framework Concepts page.
Acronym "POJO" is used but not defined. Should we define such terms?
- suggestion: link it to https://en.wikipedia.org/wiki/Plain_Old_Java_Object ?

ChangeApplierAPI.html:

Invoker link goes to "compact" section of that document.
should invoker link go to Invoker doc and the "compact" word previous to it go to the "Compact" section of the invoker document?
this should be re-examined, since there's nothing in the 'compact' section of the invoker documentation!

Additional context or notes

Originally filed as FLUID-5828 by @acheetham on December 10, 2015.