Hi Aditi,
On 4 Nov 2016, at 12:50, aditi hilbert wrote:
Hi all,
Documentation update is going to be a big part of the Apache Mynewt
1.0 release since it is featuring several additions and enhancements.
I would like to propose some changes to the landing page and
additional links on the project’s website to better cover the the
salient features of Apache Mynewt OS.
The proposed changes are in the landingFormat branch of the repo:
https://github.com/apache/incubator-mynewt-site/tree/landingFormat
You may checkout this branch and run ‘mkdocs serve’ to view the
changes.
I’ve done so — the new website looks great. This is awesome!
The main changes proposed are:
* Focus on the main strengths of the OS in landing page, present them
in a clean, comprehensive way
* Links under these feature blurbs to additional pages for a deeper
dive (e.g. to NimBLE highlights or Newt Tool docs)
* Moving the list of supported boards to the bottom so it’s easier
to keep adding to the list (there will be several added over the
course of the beta releases leading up to 1.0)
* Link in the nav bar to the “Talks” page highlighting
presentations around Mynewt OS - looking forward to some contributions
from the community!
Please provide feedback on the content as well as any other
enhancements that you would like to see.
I think the “Contributing” section of the community page should be
moved to our Wiki (and we should have a .md file in the
incubator-mynewt-newt and incubator-mynewt-core directories that points
to this as well.)
In general, I think we should find a way to link to the Wiki more
prominently, and put a bit of effort into updating the Wiki over the
next month or two.
Also, is it possible to link directly to “file a bug” and feature
that? I think we want to make it as easy as possible for users to file
issues against mynewt. I think right now it also requires a JIRA
account, is there a way to work with INFRA to allow for users to
directly file a bug?
Also note that the Technical Documentation pages are being updated in
the “develop” branch. A 1.0 beta-1 documentation release branch
will be created and tagged to go along with the upcoming 1.0 beta-1
release in the next few days. The tagged documentation will show up as
a new option in the pull-down menu inside “Documentation”.
I think it makes sense to just do 1.0 and not include the beta here. We
won’t want to keep a copy of the documentation for beta around, and
we’ll likely be actively updating documentation for 1.0 during the
beta period.
Cheers,
Sterling
