Documentation Overhaul & Stabilisation #131
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… Values and Bytes
…lates Improve CodeTemplate documentation
…tion-sections Improve AGENTS guidance
…-constants-behavior Clarify alignment annotation
…nd-explain-alignment Clarify array length and alignment Javadoc
…t-copyfrom-method Clarify copy behaviour and clean Javadoc
…a-and-constants Improve ValueModel documentation
…ves.java Clarify boolean width and boxed helper
…arsequencefieldmodel Expand CharSequence field model Javadoc
…stprimitivefieldtest Add primitive field detection comment
…ils.java Expand Utils Javadoc
…-example-to-javadoc Add native reference example
…s.adoc-with-nine-box-summary Summarise Nine-Box tag categories
…align.java Clarify Align annotation defaults
…model-class Document array field metadata
…nts-explaining-storage-and-alignme Explain bit storage and alignment in BooleanFieldModel
…e-permgen-references Clarify class loader comments
…ncefieldmodel.java
…harsequencefieldmodel.java Document UTF-8 constraints for CharSequence fields
…ignature-matching
…method-signature-matching Clarify method matching in CodeTemplate Javadoc
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Scope of changes
decision-log.adocandproject-requirements.adocwith Nine-Box taxonomy; each design decision captured with context, alternatives, rationale & impact.<p>tags for proper formatting.Review notes
** Accuracy of technical explanations (especially heap vs native and annotation semantics).
** Consistency of Nine-Box requirement tags across docs.
** Typos or non-ASCII characters that slipped through.