New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes to ChangeApplier docs #295

Open

jobara opened this issue Aug 1, 2024 · 0 comments

Labels

documentation enhancement

Member

jobara commented Aug 1, 2024

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.

jobara added documentation enhancement labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment