Skip to content

Conversation

@yiyi1991
Copy link
Contributor

@yiyi1991 yiyi1991 commented Jul 25, 2025

Update documentation for NEWPATHWAYS (a project starting from Jan 2025)

How to review

  • The newpathways.rst contains all IIASA-related working packages, makes sense to internal modelers, and assigns the correct PL/PM.

PR checklist

  • Add or expand tests; coverage checks both ✅
  • Add, expand, or update documentation.
  • Update doc/whatsnew.

p.s., once merged, Jun will be able to further work on the documentation of T3.5.
Aiming at updating the documentation when the next milestone is achieved (e.g., branches and workflows built for T3.3 or T3.5).

@yiyi1991 yiyi1991 requested a review from junukitashepard July 25, 2025 14:39
@yiyi1991 yiyi1991 self-assigned this Jul 25, 2025
@yiyi1991 yiyi1991 added the p:NEWPATHWAYS NEWPATHWAYS project label Jul 25, 2025
@codecov
Copy link

codecov bot commented Jul 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.4%. Comparing base (dbd9030) to head (ef6f910).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##            main    #385     +/-   ##
=======================================
- Coverage   77.1%   76.4%   -0.8%     
=======================================
  Files        250     250             
  Lines      20198   20198             
=======================================
- Hits       15589   15433    -156     
- Misses      4609    4765    +156     

see 8 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

@junukitashepard junukitashepard left a comment

Choose a reason for hiding this comment

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

Thanks for updating the documentation. I will add the trade portion.

@glatterf42
Copy link
Member

Thanks for the PR and the review :)
Please help me understand how we can merge this: first of, we'll need to update this branch by rebasing it on the main branch (and force-pushing it). Do you feel comfortable doing so or should I help out?
Next, please let me know what else is required: can we tick the box in the "How to review" section in the PR description?
For the last remaining box, please take a look at the doc/whatsnew.rst file. This PR should be added there with one line similar to the others (in the section for the next release).
Lastly, are we fine with merging the PR without reviews from @amastrucci and @r-aneeque or should we wait for them? If we wait and you want to update this documentation, you can either use this branch or create a new branch on top of this one -- merging this one will then shift the new branch so that it starts from main automatically.

@glatterf42 glatterf42 marked this pull request as ready for review August 8, 2025 12:59
@yiyi1991
Copy link
Contributor Author

yiyi1991 commented Aug 9, 2025

Thanks Fridolin! Rebased. (And I think we can tick the box unless Jun or anyone else sees any simple typos or obvious mistakes.) Paul helped update the whatsnew last time (New summary pages for projects :doc:project/geidco, (:pull:312)), and I am happy to follow that style. Which section should I use? v2025.8.7?

And it is ok to merge with one reviewer confirmed. I actually filled documentation for quite a few projects (in branches doc/geidco, doc/newpathways, doc/elevate, doc/efc)... and will open PRs similar to this. It will be great if @khaeru can take a look too.

@glatterf42
Copy link
Member

Happy to hear that more docs updates are coming soon :)
The section v2025.8.7 should not be used for writing new items anymore; this release has already been published, so we can't add anything to it. In this case, you should modify these lines by removing the .. in the beginning (including the whitespace) and then collect your items there :)

From my point of view, if you tell me that the information you added here is good, we can merge with a single approval. But if you think someone should take another look in particular, we can also wait until that person has time (and maybe tell them in person about this PR, including that it only takes x minutes to review).

@khaeru
Copy link
Member

khaeru commented Aug 11, 2025

Please go ahead and merge. I think it will be much easier to tidy, edit, standardize in batches, once we can see what kinds of info are contained in the documentation for multiple projects.

It's also simple to fill gaps if anyone later realizes some info was missing from this PR. No need to delay.

@yiyi1991
Copy link
Contributor Author

Thanks both. I added the whatsnew of it and similar updates of EFC and ELEVATE documentations will come soon too. Kindly help with any tidy/edit/standardize/etc. then.

@glatterf42 glatterf42 merged commit 60b7c57 into main Aug 12, 2025
7 of 8 checks passed
@glatterf42 glatterf42 deleted the doc/newpathways branch August 12, 2025 08:27
@glatterf42
Copy link
Member

(Merging this without waiting for the tests, which may not finish either way.)

hyyyyc pushed a commit to hyyyyc/message-ix-models that referenced this pull request Aug 19, 2025
* Update minimum info for NEWPATHWAYS doc

---------

Co-authored-by: Fridolin Glatter <[email protected]>
yiyi1991 added a commit that referenced this pull request Aug 25, 2025
* Update minimum info for NEWPATHWAYS doc

---------

Co-authored-by: Fridolin Glatter <[email protected]>
hyyyyc pushed a commit to hyyyyc/message-ix-models that referenced this pull request Sep 2, 2025
* Update minimum info for NEWPATHWAYS doc

---------

Co-authored-by: Fridolin Glatter <[email protected]>
@khaeru khaeru added this to the 2025-09 milestone Sep 9, 2025
hyyyyc pushed a commit to hyyyyc/message-ix-models that referenced this pull request Sep 24, 2025
* Update minimum info for NEWPATHWAYS doc

---------

Co-authored-by: Fridolin Glatter <[email protected]>
Wegatriespython pushed a commit to Wegatriespython/message-ix-models that referenced this pull request Oct 6, 2025
* Update minimum info for NEWPATHWAYS doc

---------

Co-authored-by: Fridolin Glatter <[email protected]>
junukitashepard pushed a commit to junukitashepard/message-ix-models that referenced this pull request Oct 27, 2025
* Update minimum info for NEWPATHWAYS doc

---------

Co-authored-by: Fridolin Glatter <[email protected]>
junukitashepard pushed a commit that referenced this pull request Oct 30, 2025
* Update minimum info for NEWPATHWAYS doc

---------

Co-authored-by: Fridolin Glatter <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

p:NEWPATHWAYS NEWPATHWAYS project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants