<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<html lang="en" style='--code-editor-font: var(--default-mono-font, "GitLab Mono"), JetBrains Mono, Menlo, DejaVu Sans Mono, Liberation Mono, Consolas, Ubuntu Mono, Courier New, andale mono, lucida console, monospace;'>
<head>
<meta content="text/html; charset=US-ASCII" http-equiv="Content-Type">
<title>
GitLab
</title>
<style data-premailer="ignore" type="text/css">
a { color: #1068bf; }
</style>
<style>img {
max-width: 100%; height: auto;
}
body {
font-size: .875rem;
}
body {
-webkit-text-shadow: rgba(255,255,255,.01) 0 0 1px;
}
body {
font-family: var(--default-regular-font, "GitLab Sans"),-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Noto Sans",Ubuntu,Cantarell,"Helvetica Neue",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji"; font-size: inherit;
}
</style>
</head>
<body style='font-size: inherit; -webkit-text-shadow: rgba(255,255,255,.01) 0 0 1px; font-family: var(--default-regular-font, "GitLab Sans"),-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,"Noto Sans",Ubuntu,Cantarell,"Helvetica Neue",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";'>
<div class="content">
<p class="details" style="font-style: italic; color: #737278;">
<a href="https://gitlab.rtems.org/amar">Amar Takhar</a> created an issue: <a href="https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/29">#29</a>
</p>
<p>
Assignee: Amar Takhar
</p>
<div class="md" style="color: #333238; word-wrap: break-word;">
<h2 dir="auto" style="font-size: 1.5em; font-weight: 600; padding-bottom: .3em; border-bottom-width: 1px; border-bottom-color: #bfbfc3; border-bottom-style: solid; color: #333238; margin: 0 0 16px;" align="initial">
<a href="#summary" aria-hidden="true" class="anchor" id="user-content-summary" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Summary</h2>
<p dir="auto" style="color: #333238; margin: 0 0 16px;" align="initial">RTEMS has a lot of <code style='font-size: 90%; color: #1f1e24; word-wrap: break-word; background-color: #ececef; border-radius: .25rem; margin-top: 0; font-weight: inherit; font-family: var(--default-mono-font, "GitLab Mono"),"JetBrains Mono","Menlo","DejaVu Sans Mono","Liberation Mono","Consolas","Ubuntu Mono","Courier New","andale mono","lucida console",monospace; vertical-align: bottom; white-space: pre-wrap; overflow-wrap: break-word; word-break: keep-all; padding: 2px 4px;'>README.md</code> files in <code style='font-size: 90%; color: #1f1e24; word-wrap: break-word; background-color: #ececef; border-radius: .25rem; font-weight: inherit; font-family: var(--default-mono-font, "GitLab Mono"),"JetBrains Mono","Menlo","DejaVu Sans Mono","Liberation Mono","Consolas","Ubuntu Mono","Courier New","andale mono","lucida console",monospace; vertical-align: bottom; white-space: pre-wrap; overflow-wrap: break-word; word-break: keep-all; padding: 2px 4px;'>bsp/*</code>. 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.</p>
<p dir="auto" style="color: #333238; margin: 0 0 16px;" align="initial">The goal is a user could use the getting started guide + the BSP manual to get up and running with RTEMS.</p>
<h2 dir="auto" style="font-size: 1.5em; font-weight: 600; padding-bottom: .3em; border-bottom-width: 1px; border-bottom-color: #bfbfc3; border-bottom-style: solid; color: #333238; margin: 24px 0 16px;" align="initial">
<a href="#what-needs-to-be-decided" aria-hidden="true" class="anchor" id="user-content-what-needs-to-be-decided" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>What needs to be decided</h2>
<ol dir="auto" style="text-align: initial; margin: 0 0 16px; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">Do we have one entry per BSP, always?
<ol style="margin: 0; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">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.</li>
</ol>
</li>
<li style="line-height: 1.6em; margin-left: 25px; padding-left: 3px;">What will go into the document will it be user docs strictly? What if a BSP has any engineering information
<ol style="margin: 0; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">I think it makes sense to keep the engineering documents with other engineering docs.</li>
</ol>
</li>
<li style="line-height: 1.6em; margin-left: 25px; padding-left: 3px;">Should all user-based documentation pretaining to BSPs be moved to this?</li>
</ol>
<h2 dir="auto" style="font-size: 1.5em; font-weight: 600; padding-bottom: .3em; border-bottom-width: 1px; border-bottom-color: #bfbfc3; border-bottom-style: solid; color: #333238; margin: 24px 0 16px;" align="initial">
<a href="#possible-layout" aria-hidden="true" class="anchor" id="user-content-possible-layout" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Possible layout</h2>
<ol dir="auto" style="text-align: initial; margin: 0 0 16px; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">Getting started
<ol style="margin: 0; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">Short introduction</li>
<li style="line-height: 1.6em; margin-left: 25px; padding-left: 3px;">Link to getting started manual</li>
</ol>
</li>
<li style="line-height: 1.6em; margin-left: 25px; padding-left: 3px;">Architecture
<ol style="margin: 0; padding: 0;">
<li style="margin-top: 0; line-height: 1.6em; margin-left: 25px; padding-left: 3px;">BSP</li>
<li style="line-height: 1.6em; margin-left: 25px; padding-left: 3px;">""</li>
</ol>
</li>
</ol>
<h2 dir="auto" style="font-size: 1.5em; font-weight: 600; padding-bottom: .3em; border-bottom-width: 1px; border-bottom-color: #bfbfc3; border-bottom-style: solid; color: #333238; margin: 24px 0 16px;" align="initial">
<a href="#section-layout" aria-hidden="true" class="anchor" id="user-content-section-layout" style="margin-top: 0; float: left; margin-left: -20px; text-decoration: none; outline: none;"></a>Section layout</h2>
<p dir="auto" style="color: #333238; margin: 0 0 16px;" align="initial">Part of this will be auto generated and the other will be manually edited.</p>
<p dir="auto" style="color: #333238; margin: 0;" align="initial">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.</p>
</div>
</div>
<div class="footer" style="margin-top: 10px;">
<p style="font-size: small; color: #737278;">
—
<br>
<a href="https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/29">View it on GitLab</a>.
<br>
You're receiving this email because of your account on <a target="_blank" rel="noopener noreferrer" href="https://gitlab.rtems.org">gitlab.rtems.org</a>. <a href="https://gitlab.rtems.org/-/sent_notifications/6b395fcc96656478c06584ae925fb22d/unsubscribe" target="_blank" rel="noopener noreferrer">Unsubscribe</a> from this thread · <a href="https://gitlab.rtems.org/-/profile/notifications" target="_blank" rel="noopener noreferrer" class="mng-notif-link">Manage all notifications</a> · <a href="https://gitlab.rtems.org/help" target="_blank" rel="noopener noreferrer" class="help-link">Help</a>
<script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","action":{"@type":"ViewAction","name":"View Issue","url":"https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/29"}}</script>
</p>
</div>
</body>
</html>