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

- Added a feature comparison table for supported BSPs #2266

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

chrisdutz
Copy link

No description provided.

@apache-mynewt-bot
Copy link

Style check summary

No suggestions at this time!

Copy link
Member

@utzig utzig left a comment

Choose a reason for hiding this comment

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

This doesn't show up on the site without it being linked on some index.rst file. I tested it by doing this:

--- a/docs/os/bsp/index.rst
+++ b/docs/os/bsp/index.rst
@@ -25,4 +25,5 @@ be found in `@apache-mynewt-core/hw/bsp <https://github.com/apache/mynewt-core/t
 .. toctree::
     :maxdepth: 1
 
+    BSP features table <table>
     PineTime <pinetime>

The issue here, is that our design does have overflows disabled, so scrollbars don't show up, and it's not possible to move to the right columns. It would be possible to containerize this table and enable overflows, but the results won't look great. I am thinking if it wouldn't be a better idea to add this table to the wiki (https://github.com/apache/mynewt-core/wiki) or some other place that can display pages in full screen without a floating nav, and link it on the BSP documentation index?

@@ -0,0 +1,151 @@
..
#
# Copyright 2020 Casper Meijn <[email protected]>
Copy link
Member

Choose a reason for hiding this comment

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

Copy/pasta?

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure documentation needs copyright, but if you want to leave it here, the # prefix can be removed as well, it's not part of RsT syntax.

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we try the wiki option @utzig?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants