> > 2. Split up the ReleaseNotes file? As it is now, it reads a bit more like a
> > ChangeLog rather than ReleaseNotes. In the past we talked about a
> > Documentation/ReleaseNotes directory that could hold a separate
> > ReleaseNotes for each major version?
> >
> They are broken out per release and linked on the download page.

It would still be a good idea if we can do this to the main
ReleaseNote file as well.  It's 29344 lines long (and counting).  We
talked before about keeping the latest notes in the top level
ReleaseNote and kind of archive the rest somewhere else.


On Fri, May 28, 2021 at 4:56 PM Nathan Hartman <hartman.nat...@gmail.com> wrote:
>
> On Fri, May 28, 2021 at 11:49 AM Nathan Hartman
> <hartman.nat...@gmail.com> wrote:
> >
> > On Fri, May 28, 2021 at 11:43 AM Brennan Ashton
> > <bash...@brennanashton.com> wrote:
> > >
> > > On Fri, May 28, 2021, 7:54 AM Nathan Hartman <hartman.nat...@gmail.com>
> > > > 3. Make a ReleaseNotes section of the website that will render those
> > > > ReleaseNotes files and offer an easy to use index, so it's easier to 
> > > > find
> > > > this information. The newer ones are Markdown but not rendered as such 
> > > > when
> > > > opened in any text editor or browser because of all the preexisting
> > > > non-markdown content.
> > > >
> > >
> > > Already done
> > > http://nuttx.apache.org/releases/10.0.0/#compatibility-concerns
> >
> > I completely missed that! Thanks!
>
> I see why I missed it. It wasn't obvious (to me, anyway) that the
> version numbers in the left column were links to the release notes for
> that version.
>
> Perhaps there should be a column called Release Notes with the links.
> I'll try to experiment with it later and if I can come up with
> something more clear, I'll send a PR for review.
>
> Thanks,
> Nathan

Reply via email to