Skip to content

docs(config_guide): add graduation guides and update scoring#130

Open
emjay0921 wants to merge 2 commits intov2-in-progress-3from
fix/config-guide-822-program-config
Open

docs(config_guide): add graduation guides and update scoring#130
emjay0921 wants to merge 2 commits intov2-in-progress-3from
fix/config-guide-822-program-config

Conversation

@emjay0921
Copy link
Copy Markdown
Contributor

Why is this change needed?

Adds new graduation configuration guides and updates scoring documentation for accuracy.

How was the change implemented?

  • Added config_guide/graduation/ (index.md, overview.md, criteria.md) — pathways, criteria, assessment methods
  • Updated config_guide/scoring/ (index.md, overview.md) — scoring models and frameworks
  • Added 4 screenshots (graduation pathways + scoring models)

Related links

https://projects.acn.fr/projects/acn-eng/work_packages/822

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces comprehensive documentation for the Graduation module, covering criteria, pathways, and assessment processes, while also updating the scoring documentation with illustrative figures. A review comment identifies an inconsistency in the graduation overview where exit types are described as 'neutral' instead of 'Negative', recommending a terminology update for alignment with subsequent tables.


| Layer | What it does | Example |
|-------|--------------|---------|
| **Pathway** | Defines the type of exit | "Standard Graduation" (positive), "Administrative Exit" (neutral) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The term "neutral" is used here to describe the "Administrative Exit" pathway, but the "Exit Type" field is defined as having only "Positive" or "Negative" values (line 30). Furthermore, the tables on lines 40 and 55 explicitly categorize "Administrative Exit" as "Negative". For consistency and to align with the defined field values, this should be updated to "Negative" (and "positive" to "Positive").

Suggested change
| **Pathway** | Defines the type of exit | "Standard Graduation" (positive), "Administrative Exit" (neutral) |
| **Pathway** | Defines the type of exit | "Standard Graduation" (Positive), "Administrative Exit" (Negative) |

…eneric guidance

The z_ind_grp_* field names do not exist in the OpenSPP2 codebase.
Multiplier fields are dynamically selected from any integer field on
res.partner. Updated docs to explain this and direct users to create
computed fields if needed.
@sonarqubecloud
Copy link
Copy Markdown

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant