From 55fe6b71262f5e455c90ae90d648e08f96b34774 Mon Sep 17 00:00:00 2001
From: Ivan Smolin <ivan.smolin@touchin.ru>
Date: Fri, 17 Feb 2023 15:32:37 +0300
Subject: [PATCH] docs: fix review notes

---
 README.md                                     | 63 ++++++++++++++++++-
 .../Contents.swift                            |  2 +-
 docs/tifoundationutils/asyncoperation.md      |  2 +-
 project-scripts/gen_docs_from_playgrounds.sh  |  2 +-
 4 files changed, 65 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index db51062a..e78ba9ca 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,68 @@ This repository contains the following frameworks:
 - [TIYandexMapUtils](TIYandexMapUtils) - set of helpers for map objects clustering and interacting using Yandex Maps SDK.
 - [TIAuth](TIAuth) - login, registration, confirmation and other related actions
 
-Docs:
+## Playgrounds
+
+### Create new Playground
+
+```sh
+cd TIModuleName
+nef plaground --name TIModuleName --cocoapods --custom-podfile PlaygroundPodfile
+```
+See example of `PlaygroundPodfile` in `TIFoundationUtils`
+
+
+### Rename/add pages to Playground
+
+For every new feature in module create new Playground page with documentation in comments. See [nef markdown documentation](https://github.com/bow-swift/nef#-generating-a-markdown-project).
+
+### Create symlink to nef playground
+
+```sh
+cd TIModuleName
+ln -s TIModuleName.app/Contents/MacOS/TIModuleName.playground TIModuleName.playground
+```
+
+### Add nef files to TIModuleName.app/.gitignore
+
+```
+# gitignore nef files
+**/build/
+**/nef/
+LICENSE
+```
+
+### Add new playground to pre release script
+
+`project-scripts/gen_docs_from_playgrounds.sh`:
+
+```sh
+PLAYGROUNDS="${SRCROOT}/TIFoundationUtils/TIFoundationUtils.app
+${SRCROOT}/TIModuleName/TIModuleName.app"
+```
+
+### Exclude .app bundles from package sources
+
+#### SPM
+
+```swift
+.target(name: "TIModuleName", dependencies: ..., path: ..., exclude: ["TIModuleName.app"]),
+```
+
+#### Podspec
+
+```ruby
+  sources = 'your_sources_expression'
+  if File.basename(Dir.getwd) == s.name # installing using :path =>
+    s.source_files = sources
+    s.exclude_files = s.name + '.app'
+  else
+    s.source_files = s.name + '/' + sources
+    s.exclude_files = s.name + '/*.app'
+  end
+```
+
+## Docs:
 
 - [TIFoundationUtils](docs/tifoundationutils)
   * [AsyncOperation](docs/tifoundationutils/asyncoperation.md)
diff --git a/TIFoundationUtils/TIFoundationUtils.app/Contents/MacOS/TIFoundationUtils.playground/Pages/AsyncOperation.xcplaygroundpage/Contents.swift b/TIFoundationUtils/TIFoundationUtils.app/Contents/MacOS/TIFoundationUtils.playground/Pages/AsyncOperation.xcplaygroundpage/Contents.swift
index 546742db..37a1769a 100644
--- a/TIFoundationUtils/TIFoundationUtils.app/Contents/MacOS/TIFoundationUtils.playground/Pages/AsyncOperation.xcplaygroundpage/Contents.swift
+++ b/TIFoundationUtils/TIFoundationUtils.app/Contents/MacOS/TIFoundationUtils.playground/Pages/AsyncOperation.xcplaygroundpage/Contents.swift
@@ -9,7 +9,7 @@
 
  ## Базовые операции
 
- "Из коробки", на данный момент, доступен всего один сабкласс асинхронной операции, потому что болльше обычно и не нужно.
+ "Из коробки", на данный момент, доступен всего один сабкласс асинхронной операции, потому что больше обычно и не нужно.
  Но можно наследоваться и создавать собственные сабклассы при необходимости.
  */
 
diff --git a/docs/tifoundationutils/asyncoperation.md b/docs/tifoundationutils/asyncoperation.md
index d6b5ef6a..5a2175e1 100644
--- a/docs/tifoundationutils/asyncoperation.md
+++ b/docs/tifoundationutils/asyncoperation.md
@@ -9,7 +9,7 @@
 
 ## Базовые операции
 
- "Из коробки", на данный момент, доступен всего один сабкласс асинхронной операции, потому что болльше обычно и не нужно.
+ "Из коробки", на данный момент, доступен всего один сабкласс асинхронной операции, потому что больше обычно и не нужно.
  Но можно наследоваться и создавать собственные сабклассы при необходимости.
 
 ### `ClosureAsyncOperation<Result, Error>`
diff --git a/project-scripts/gen_docs_from_playgrounds.sh b/project-scripts/gen_docs_from_playgrounds.sh
index 9e5c172a..bbe2e37e 100755
--- a/project-scripts/gen_docs_from_playgrounds.sh
+++ b/project-scripts/gen_docs_from_playgrounds.sh
@@ -10,6 +10,6 @@
 PLAYGROUNDS="${SRCROOT}/TIFoundationUtils/TIFoundationUtils.app"
 
 for playground_path in ${PLAYGROUNDS}; do
-    nef compile --project ${playground_path}
+    nef compile --project ${playground_path} --use-cache
     nef markdown --project ${playground_path} --output ../docs
 done
\ No newline at end of file