docs:opkg: clean up RST#91
Conversation
a51fc44 to
b8f9f4c
Compare
Patch V2
|
There was a problem hiding this comment.
Pull Request Overview
This PR cleans up and improves the RST documentation for opkg tutorials by addressing minor formatting issues and improving readability. The changes focus on:
- Replacing bold formatting with inline literal markup for code elements and applications
- Changing references from ".ipks" and ".debs" to "IPKs" and "DEBs" for consistency
- Reflowing prose to break on sentence boundaries for better diff readability
- Minor content clarifications and link reference improvements
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/source/opkg/opkg_intro.rst | Updates formatting, terminology, and prose flow for the basic opkg tutorial |
| docs/source/opkg/dkms_opkg.rst | Applies similar formatting and terminology improvements to the DKMS-based kernel module tutorial |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
* Fixup minor RST layout issues. * Use inline literal markup for inline code and applications, rather than bold. * Refer to IPKs and DEBs, instead of .ipks and .debs in most places. * Reflow prose to line-break on sentence ends, for easier diffing. * Minor content changes for clarity. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
Let's not check binary tarballs into the git source. Instead, we can build the example IPK tars from Make. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
No reason to advertise Charlie Johnston's defunct email when we can just use the generic email address for the RTOS team. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
b8f9f4c to
b98ad7e
Compare
Patch v2
|
|
When I build and preview the HTML content locally, I see a lot of lines wrapping with syllable-boundary hyphenation. Wrapping on word boundaries seems more readable. Was this intentional or just an unintended side effect? |
|
When I extract the new locally built dkms_opkg.tar.gz archive, I noticed that it lost the containing dkms_opkg directory upon extraction. Instead it extracts the hello and module_src directories directly into the current directory. This is different than opkg_intro.tar.gz and different than the old dkms_opkg.tar.gz. Perhaps unintended? |
Summary
Testing
make htmllocally and manually validated that the opkg tutorials look better and the links work.