From ce261dd2e6976ef133164ec586f00ae867a54eed Mon Sep 17 00:00:00 2001 From: Jake Howerton Date: Fri, 3 May 2019 20:23:51 -0500 Subject: [PATCH] add warning for `config.docs_dir` --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index df541bd5..5a1113f3 100644 --- a/README.md +++ b/README.md @@ -185,6 +185,7 @@ RspecApiDocumentation.configure do |config| config.configurations_dir = Rails.root.join("doc", "configurations", "api") # Output folder + # **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory. config.docs_dir = Rails.root.join("doc", "api") # An array of output format(s). @@ -238,6 +239,7 @@ RspecApiDocumentation.configure do |config| config.define_group :public do |config| # By default the group's doc_dir is a subfolder under the parent group, based # on the group's name. + # **WARNING*** All contents of the configured directory will be cleared, use a dedicated directory. config.docs_dir = Rails.root.join("doc", "api", "public") # Change the filter to only include :public examples