aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2022-10-08 17:49:09 +0200
committerGitHub <noreply@github.com>2022-10-08 17:49:09 +0200
commit93117b358778487d85665035b6a95976eee70d9c (patch)
tree5d5c90eac04faee27eb25b463ce485e797f131e1
parentb05e10ef7265c257be79e6888cbf87bb6ba86845 (diff)
downloadrneovim-93117b358778487d85665035b6a95976eee70d9c.tar.gz
rneovim-93117b358778487d85665035b6a95976eee70d9c.tar.bz2
rneovim-93117b358778487d85665035b6a95976eee70d9c.zip
docs(news): add news.txt and link from README (#20426)
-rw-r--r--README.md4
-rw-r--r--runtime/doc/news.txt39
-rw-r--r--scripts/gen_help_html.lua1
3 files changed, 43 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7be8dc77b1..c14531c997 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,8 @@ Features
- [XDG base directories](https://github.com/neovim/neovim/pull/3470) support
- Compatible with most Vim plugins, including Ruby and Python plugins
-See [`:help nvim-features`][nvim-features] for the full list!
+See [`:help nvim-features`][nvim-features] for the full list, and `[:help
+news][nvim-news]` for noteworthy changes in the latest version!
Install from package
--------------------
@@ -116,6 +117,7 @@ Apache 2.0 license, except for contributions copied from Vim (identified by the
[license-commit]: https://github.com/neovim/neovim/commit/b17d9691a24099c9210289f16afb1a498a89d803
[nvim-features]: https://neovim.io/doc/user/vim_diff.html#nvim-features
+[nvim-news]: https://neovim.io/doc/user/news.html
[Roadmap]: https://neovim.io/roadmap/
[advanced UIs]: https://github.com/neovim/neovim/wiki/Related-projects#gui
[Managed packages]: https://github.com/neovim/neovim/wiki/Installing-Neovim#install-from-package
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
new file mode 100644
index 0000000000..0fdd7aaaf9
--- /dev/null
+++ b/runtime/doc/news.txt
@@ -0,0 +1,39 @@
+*news.txt* Nvim
+
+
+ NVIM REFERENCE MANUAL
+
+
+Notable changes in Nvim 0.9 from 0.8 *news*
+
+ Type |gO| to see the table of contents.
+
+==============================================================================
+BREAKING CHANGES *news-breaking*
+
+The following changes may require adaptations in user config or plugins.
+
+==============================================================================
+NEW FEATURES *news-features*
+
+The following new APIs or features were added.
+
+==============================================================================
+CHANGED FEATURES *news-changes*
+
+The following changes to existing APIs or features add new behavior.
+
+==============================================================================
+REMOVED FEATURES *news-removed*
+
+The following deprecated functions or APIs were removed.
+
+==============================================================================
+DEPRECATIONS *news-deprecations*
+
+The following functions are now deprecated and will be removed in the next
+release.
+
+
+
+ vim:tw=78:ts=8:sw=2:et:ft=help:norl:
diff --git a/scripts/gen_help_html.lua b/scripts/gen_help_html.lua
index 15269ce175..540caa2ae3 100644
--- a/scripts/gen_help_html.lua
+++ b/scripts/gen_help_html.lua
@@ -44,6 +44,7 @@ local new_layout = {
['channel.txt'] = true,
['develop.txt'] = true,
['luaref.txt'] = true,
+ ['news.txt'] = true,
['nvim.txt'] = true,
['pi_health.txt'] = true,
['provider.txt'] = true,