Skip to content

Documentation: move debug pages to a separate top level page #16033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

raiden00pl
Copy link
Member

Summary

Move debug related pages from Guides to a separate top level page. This way all pages related to debugging will be in one place which is more user friendly.

Related Github issue: #15667

Impact

doc only

Testing

local doc build

Move debug related pages from Guides to a separate top level page.
This way all pages related to debugging will be in one place
which is more user friendly.

Related Github issue: apache#15667

Signed-off-by: raiden00pl <[email protected]>
@github-actions github-actions bot added the Area: Documentation Improvements or additions to documentation label Mar 22, 2025
@raiden00pl raiden00pl linked an issue Mar 22, 2025 that may be closed by this pull request
1 task
@github-actions github-actions bot added the Size: S The size of the change in this PR is small label Mar 22, 2025
@nuttxpr
Copy link

nuttxpr commented Mar 22, 2025

[Experimental Bot, please feedback here]

Yes, this PR appears to meet the NuttX requirements, although some sections could be more detailed. Specifically:

  • Summary: While concise, it could benefit from briefly mentioning how the debug information is reorganized. For instance, "This PR moves all debug-related pages from the Guides section to a new, dedicated 'Debugging' top-level page, centralizing this information for easier access."
  • Impact: While "doc only" is correct, expanding slightly would be beneficial. E.g., "Impact on documentation: YES. This restructures the documentation by creating a new top-level Debugging section and moving existing content. No content is changed, only reorganized." This clarifies that the content remains unchanged, only its location.
  • Testing: While "local doc build" indicates testing was performed, it lacks specifics. It should specify the OS and any relevant tools used for the build (e.g., "Build Host: macOS Ventura, Sphinx"). The "Testing logs before change" and "Testing logs after change" sections are empty and, while perhaps not strictly required for a documentation-only change, including something like a directory listing of the documentation before and after the change would improve thoroughness.

By adding these minor clarifications, the PR will be even stronger and easier for reviewers to assess.

Copy link
Contributor

@acassis acassis left a comment

Choose a reason for hiding this comment

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

Nice improvement @raiden00pl !!! Kudos!

@xiaoxiang781216 xiaoxiang781216 merged commit 9394962 into apache:master Mar 24, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Documentation: move debugging tools in one place
4 participants