Documentation | Create new BSP manual (#29)

[Amar Takhar (@amar)]

Amar Takhar created an issue: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/29

Assignee: Amar Takhar

## Summary

RTEMS has a lot of `README.md` files in `bsp/*`.  We have not wanted documentation in source for a long time as this promotes not being updated.  We've decided the best course of action is to create a new manual specifically targeted at BSPs.

The goal is a user could use the getting started guide + the BSP manual to get up and running with RTEMS.

## What needs to be decided

1. Do we have one entry per BSP, always?
   1. If so we could extract name, title, location and some simple details and settings from the source repository for an 'auto generated' portion.  This would require having RTEMS source available when building the docs.
2. What will go into the document will it be user docs strictly?  What if a BSP has any engineering information
   1. I think it makes sense to keep the engineering documents with other engineering docs.
3. Should all user-based documentation pretaining to BSPs be moved to this?

## Possible layout

1. Getting started
   1. Short introduction
   2. Link to getting started manual
2. Architecture
   1. BSP
   2. ""

## Section layout

Part of this will be auto generated and the other will be manually edited.

If a BSP does not have any handwritten content then only the auto generated content will be available.  It's still to be determined if we can autogenerate anything that is useful for users it's better to not have an endless list of repetitive content but if we can do get something useful and collect enough we can go this route.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/29
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20240816/a5cedbe8/attachment.htm>