aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAshkan Kiani <ashkan.k.kiani@gmail.com>2019-11-14 15:20:31 -0800
committerGitHub <noreply@github.com>2019-11-14 15:20:31 -0800
commitec406e17fd86c321b084d877f66bc5f0280ed5c0 (patch)
treed15b5bd511ceef537841a2e300b9602c194882a8 /CONTRIBUTING.md
parentSmall edits to readme (#4) (diff)
downloadnvim-lspconfig-ec406e17fd86c321b084d877f66bc5f0280ed5c0.tar
nvim-lspconfig-ec406e17fd86c321b084d877f66bc5f0280ed5c0.tar.gz
nvim-lspconfig-ec406e17fd86c321b084d877f66bc5f0280ed5c0.tar.bz2
nvim-lspconfig-ec406e17fd86c321b084d877f66bc5f0280ed5c0.tar.lz
nvim-lspconfig-ec406e17fd86c321b084d877f66bc5f0280ed5c0.tar.xz
nvim-lspconfig-ec406e17fd86c321b084d877f66bc5f0280ed5c0.tar.zst
nvim-lspconfig-ec406e17fd86c321b084d877f66bc5f0280ed5c0.zip
Add github actions for docgen (#7)
* Create main.yml * Update CONTRIBUTING and REAMDE. Explain that Github Actions generate README.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index efa8af67..d46017f7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,6 +5,11 @@
# Generating docs
+> NOTE: Github Actions automatically generates the docs, so only modify
+> README_preamble.md or the `docs` in the server config!
+
+The instructions here are for previewing changes locally.
+
`scripts/docgen.lua` was written with the intention of being sourced (like with `luafile`)
from `nvim` to run.
@@ -18,6 +23,7 @@ copy of `nvim_lsp` on your system.
This generates a suffix for README.md
+
# skeleton
skeleton has a `__newindex` metamethod which validates and creates