Improve PEcAn.SIPNET README and documentation structure#3961
Improve PEcAn.SIPNET README and documentation structure#3961sujalkurkute wants to merge 3 commits intoPecanProject:developfrom
Conversation
|
Hey @sujalkurkute, welcome and thanks for the PR! 🙌 Just a heads up PR #3705 was already merged on March 7 and covered most of what's here (What is SIPNET, installation updates, demo links etc). Your changes might conflict with or revert some of that work. The Documentation Structure section you added is a nice touch that isn't in either of those PRs though! Would suggest rebasing on develop first and then seeing what still makes sense to keep. Happy to help if you have questions! 👍 |
|
Thanks @omkarrr2533 for the feedback! I’ll rebase my branch on develop and remove the duplicate changes that are already covered in PR #3705. I’ll keep and refine the documentation structure section. Appreciate your guidance! |
|
Thanks for the feedback! I have rebased my branch, removed the duplicate content, and kept only the documentation structure section. Please let me know if any further changes are needed. |
Description
This PR improves the PEcAn.SIPNET README to provide clearer, more structured, and user-friendly documentation.
Changes include:
Motivation and Context
The existing SIPNET documentation was fragmented and contained generic/template content. This update improves clarity, removes duplication, and provides better navigation between README, PEcAn documentation, and SIPNET standalone docs.
Fixes: #3703
Review Time Estimate
Types of changes
Checklist: