Restructured deeply nested documentation files#3752
Open
shreyannandanwar wants to merge 19 commits intoPecanProject:developfrom
Open
Restructured deeply nested documentation files#3752shreyannandanwar wants to merge 19 commits intoPecanProject:developfrom
shreyannandanwar wants to merge 19 commits intoPecanProject:developfrom
Conversation
Contributor
Author
|
@divine7022 do u suggest any changes? |
infotroph
requested changes
Jan 11, 2026
Contributor
Author
|
thank you the feedback @infotroph I will get it done. |
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Contributor
Author
|
@infotroph I have done new changes review it and let me know. |
unnecessary `<br>` are removed
? in review fixed
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.
Description
This PR restructures documentation sections that had excessively deep heading hierarchies in order to improve navigation, readability, and conceptual clarity. The changes focus on correcting the document structure itself by aligning heading depth with conceptual importance.
Specifically, this PR:
This PR serves as a pilot restructuring that establishes a clear and reusable pattern for addressing similar structural issues elsewhere in the documentation.
Motivation and Context
Several PEcAn documentation files contained heading hierarchies 5–6 levels deep (e.g. section numbers like 15.2.3.4.1.2), leading to poor navigation, unreadable numbering, and structural inconsistencies such as skipped heading levels. Many deeply nested sections represented examples or procedural variants rather than true conceptual hierarchy.
Earlier discussion considered hiding deep section numbers via CSS, but this would only mask the underlying organizational problems. This PR addresses the root cause by restructuring the content hierarchy so numbering depth becomes manageable naturally.
Fixes #3741.
Review Time Estimate
Types of changes
Checklist: