Skip to content

Conversation

@Ayush1325
Copy link
Member

@Ayush1325 Ayush1325 commented Oct 7, 2024

@zephyrbot zephyrbot added the platform: BeagleBoard BeagleBoard.org Foundation label Oct 7, 2024
@con-pax
Copy link
Contributor

con-pax commented Oct 7, 2024

Hey @Ayush1325, thanks for the PR. is it not overkill having 3 seperate docs for the one board? would it not be better to describe the variants in a single doc?

@Ayush1325
Copy link
Member Author

Hey @Ayush1325, thanks for the PR. is it not overkill having 3 seperate docs for the one board? would it not be better to describe the variants in a single doc?

Well, for a board like beagleplay, I would prefer to have separate docs for each target. Having separate docs allows for providing specific instructions for building, debugging, peripheral numbering, etc, more clearly. But I am not familiar enough with the difference between the capabilities of e15 and u54 to say if they are different enough to warrant separate pages. I am just trying to facilitate the future target specific doc improvement.

I would be okay with whatever upstream Zephyr prefers to be honest. It's just important to have docs that can clearly explain that 3 different targets can be used for beaglev-fire.

@Ayush1325
Copy link
Member Author

@con-pax I now have a single page for beaglev-fire and just added the targets and fixed the build example.

con-pax
con-pax previously approved these changes Oct 8, 2024
Copy link
Contributor

@con-pax con-pax left a comment

Choose a reason for hiding this comment

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

LGTM

@mmahadevan108
Copy link
Contributor

@gbcstott, this is the fix to the documentation per your issue. Can you please review.

@Ayush1325 Ayush1325 force-pushed the beaglev-fire-doc branch 2 times, most recently from d989eb9 to 4ce16b3 Compare October 9, 2024 08:31
@gbcstott
Copy link

I looked at the doc preview for this change and it looks great. Thanks.

@Ayush1325 Ayush1325 force-pushed the beaglev-fire-doc branch 2 times, most recently from 842ef61 to 082b83c Compare October 10, 2024 08:28
@kartben kartben changed the title boards: beagle: beaglev_fire: Have seperate docs for different targets boards: beagle: beaglev_fire: Specify the different targets supported for beaglev_fire and fix build instructions Oct 10, 2024
@Ayush1325 Ayush1325 requested a review from con-pax October 12, 2024 05:54
- Fix the board name in build example
- Add link to datasheet
- Specify the different targets supported for beaglev_fire

Signed-off-by: Ayush Singh <[email protected]>
@jadonk
Copy link
Member

jadonk commented Oct 16, 2024

@Ayush1325 can you describe the process of loading "hello world" without using OpenOCD? Is there a way to enable west flash?

@Ayush1325
Copy link
Member Author

@Ayush1325 can you describe the process of loading "hello world" without using OpenOCD? Is there a way to enable west flash?

I do not have much idea since I do not have a beaglev-fire. But I have posted the link to this on Discord, so hopefully, someone can comment.

@Ayush1325
Copy link
Member Author

Closing in favor of #80656

@Ayush1325 Ayush1325 closed this Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

platform: BeagleBoard BeagleBoard.org Foundation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: Documentation issue in 'boards/beagle/beaglev_fire/doc/index'

7 participants