Expand terminology glossary and add CONTEXT.md#652
Open
ecomodeller wants to merge 1 commit into
Open
Conversation
User-facing terminology page (`docs/user-guide/terminology.qmd`): - Add Field, Geometry type (gtype), Baseline, and Quantity as first-class entries. - Reframe Score as primarily a ComparerCollection concept; Comparer.score is the degenerate single-observation case. - Fold Performance into Skill as an alias instead of a separate entry. - Fix Observation links that pointed to ModelResult classes. - Rewrite the Timeseries entry to contrast with fields explicitly (Grid/dfsu are fields, not timeseries). - Use "flexible mesh (dfsu)" for the geometry concept; keep "dfsu" for the file format. Aligns with mikeio's vocabulary. - Reorder entries by topic (framing -> data shapes -> matching -> assessment -> abbreviations). Add a dev-facing `CONTEXT.md` at the repo root that mirrors the user-facing glossary, additionally documents the Vertical alpha vocabulary that is not yet stable for public docs, and records conventions (z-axis direction, dfsu-vs-flexible-mesh, performance-vs-skill, unstructured enum legacy name).
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
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.
Summary
User-facing glossary (
docs/user-guide/terminology.qmd):ComparerCollectionconcept (the cross-observation weighted average is what makes the result a single representative number);Comparer.scoreis documented as the degenerate single-observation case. Keeps the link target onComparerCollection.score.PointModelResult/TrackModelResultinstead ofPointObservation/TrackObservation.DfsuModelResult(class) stays — it is file-anchored.GeometryType.UNSTRUCTURED(enum) is flagged as legacy in CONTEXT.md but not renamed in this PR.Adds a dev-facing
CONTEXT.mdat the repo root:VerticalObservation,VerticalModelResult,SkillProfile,cmp.verticalaccessor) which is deliberately kept out of the user-facing terminology page until the surface stabilises.positive="up"default, see MIKE 3 convention), dfsu-vs-flexible-mesh distinction, the skill-vs-score granularity asymmetry, and the legacyUNSTRUCTUREDenum name.Test plan
just docsrenders without warnings on the new terminology.qmd anchors (#field,#geometry-type-gtype,#baseline,#quantity).