Skip to content
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

Doc: loading ELF program #15376

Merged
merged 1 commit into from
Dec 29, 2024
Merged

Conversation

lvanasse
Copy link
Contributor

Migrate the Updating a release system with ELF programs with child pages to official wiki.

Summary

Migrated the Updating a release system with ELF programs with its child pages to the official wiki

Impact

  • Update the wiki

Testing

  • Build with make autobuild

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: L The size of the change in this PR is large labels Dec 29, 2024
@nuttxpr
Copy link

nuttxpr commented Dec 29, 2024

[Experimental Bot, please feedback here]

No, this PR likely does not fully meet the NuttX requirements based on the provided information. Here's why:

  • Insufficient Summary: While stating the "what," the summary lacks crucial details like "why" this migration is necessary. What problem does it solve? Why is the wiki a better place for this information than where it was previously? How does the migration work (e.g., simple copy/paste, reformatting, etc.)?
  • Missing Impact Details: Saying "Update the wiki" is too vague. Does this change how users update their systems? Does it affect any build processes? Are there any compatibility concerns with older documentation or tools? The impact section requires more specific YES/NO answers with explanations.
  • Inadequate Testing: "Build with make autobuild" doesn't demonstrate that the wiki content itself is correct or helpful. Testing should involve verifying the migrated documentation renders correctly, that the information is accurate, and ideally, that someone can successfully follow the instructions. Since this is documentation, the "before" and "after" logs are not relevant in the same way as for code changes. Instead, you should provide links to the old and new locations of the documentation.

To improve this PR, consider adding the following:

  • Explain the motivation: Why was this migration necessary? Was the previous location inaccessible, outdated, or otherwise problematic? What benefits does the wiki offer?
  • Detail the process: How was the content migrated? Was it simply copied, or was it revised and updated?
  • Specify the impact: Address all the impact questions with clear YES/NO answers and detailed explanations. Focus on how this change affects users of the documentation.
  • Provide relevant testing information: Include links to the old and new locations of the documentation. Explain how you verified the accuracy and completeness of the migrated content. Did you test the instructions by following them yourself?

By addressing these points, you can make a much stronger case for merging your PR.

Migrate the Updating a release System with ELF programs with child pages
to official wiki
@acassis
Copy link
Contributor

acassis commented Dec 29, 2024

Nice work @lvanasse !!! Did you test this documentation recently? Many of our old documentation is outdated and needs to be update to reflect current NuttX code

@xiaoxiang781216 xiaoxiang781216 merged commit 04c7391 into apache:master Dec 29, 2024
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: L The size of the change in this PR is large
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants