From ec406e17fd86c321b084d877f66bc5f0280ed5c0 Mon Sep 17 00:00:00 2001 From: Ashkan Kiani Date: Thu, 14 Nov 2019 15:20:31 -0800 Subject: Add github actions for docgen (#7) * Create main.yml * Update CONTRIBUTING and REAMDE. Explain that Github Actions generate README. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'CONTRIBUTING.md') 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 -- cgit v1.2.3-70-g09d2