conf: расставить ссылки на доку

issue: https://st.yandex-team.ru/
462a9a825049ade39a9a4bc1f50b3e3f72c4ded5

7 files changed, 70 insertions, 5 deletions

diff --git a/build/conf/ts/ts.conf b/build/conf/ts/ts.conf
index 4fb763242b..47c1aebd2f 100644
--- a/build/conf/ts/ts.conf
+++ b/build/conf/ts/ts.conf
@@ -16,6 +16,8 @@ TS_CONFIG_PATH=tsconfig.json
 ### Macro sets the path for "TypeScript Config".
 ###
 ### - ConfigPath - config path (one at least)
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/macros#ts-config
 macro TS_CONFIG(FirstConfigPath, ConfigPath...) {
     SET(TS_CONFIG_PATH $FirstConfigPath $ConfigPath)
 }
@@ -59,6 +61,8 @@ TS_GLOB_EXCLUDE_ADDITIONAL=
 ### These files won't be copied to BINDIR.
 ###
 ### - GlobExpression - glob expression
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/macros#ts-exclude-files-glob
 macro TS_EXCLUDE_FILES_GLOB(GlobExpression) {
   SET(TS_GLOB_EXCLUDE_ADDITIONAL $GlobExpression)
 }
@@ -99,6 +103,8 @@ ESLINT_CONFIG_PATH=.eslintrc.js
 ### Macro sets the path for ESLint config file.
 ###
 ### - ConfigPath - config path
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/macros#ts-eslint-config
 macro TS_ESLINT_CONFIG(ConfigName) {
   SET(ESLINT_CONFIG_PATH $ConfigName)
 }
diff --git a/build/conf/ts/ts_next.conf b/build/conf/ts/ts_next.conf
index fa3cddd631..db25950527 100644
--- a/build/conf/ts/ts_next.conf
+++ b/build/conf/ts/ts_next.conf
@@ -4,7 +4,9 @@ TS_NEXT_CONFIG_PATH=next.config.js
 ###
 ### Macro sets the config path for TS_NEXT module.
 ###
-### - ConfigPath - config path
+### - ConfigPath - config path. Default value: next.config.js
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_NEXT#ts-next-config
 macro TS_NEXT_CONFIG(ConfigPath) {
     SET(TS_NEXT_CONFIG_PATH $ConfigPath)
 }
@@ -16,7 +18,9 @@ TS_NEXT_OUTPUT_DIR=.next
 ###
 ### Macro sets the output directory name for TS_NEXT module.
 ###
-### - DirName - output directory name
+### - DirName - output directory name. Default value: .next.
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_NEXT#ts-next-output
 macro TS_NEXT_OUTPUT(DirName) {
     SET(TS_NEXT_OUTPUT_DIR $DirName)
 }
@@ -32,12 +36,14 @@ TS_NEXT_CMD=$TOUCH_UNIT \
     ${output;hide:"package.json"} \
     ${kv;hide:"pc magenta"} ${kv;hide:"p TS_NXT"}
 
-### @usage: TS_NEXT()
+### @usage: TS_NEXT([name])
 ###
 ### NextJS app, built with `next build`. Requires sources to be under /src folder.
 ### /pages and /app on the root level ar not supported.
 ### Build results are output.tar.
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_NEXT
+###
 ### @example
 ###
 ###     TS_NEXT()
diff --git a/build/conf/ts/ts_package.conf b/build/conf/ts/ts_package.conf
index b93ac6216a..76abb4f853 100644
--- a/build/conf/ts/ts_package.conf
+++ b/build/conf/ts/ts_package.conf
@@ -5,6 +5,7 @@ TS_PACK=$TOUCH_UNIT \
     && $_TS_FILES_COPY_CMD \
     ${kv;hide:"p TS_PKG"} ${kv;hide:"pc magenta"}
 
+### # internal
 macro _TS_PACKAGE_EPILOGUE() {
   _TS_PACKAGE_CHECK_FILES()
 }
@@ -15,6 +16,8 @@ macro _TS_PACKAGE_EPILOGUE() {
 ### and is just a set of files and NPM dependencies. List required files in TS_FILES macro.
 ### `package.json` is included by default.
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_PACKAGE
+###
 ### @example
 ###
 ###     TS_PACKAGE()
diff --git a/build/conf/ts/ts_test.conf b/build/conf/ts/ts_test.conf
index b4b1fc740a..19bcfcc6cc 100644
--- a/build/conf/ts/ts_test.conf
+++ b/build/conf/ts/ts_test.conf
@@ -19,6 +19,8 @@ TS_TEST_JEST_CMD=$TOUCH_UNIT \
 ###
 ### Defines testing module with jest test runner.
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_TEST_JEST_FOR
+###
 ### @example
 ###
 ###     TS_TEST_JEST_FOR(path/to/module)
@@ -52,6 +54,8 @@ TS_TEST_HERMIONE_CMD=$TOUCH_UNIT \
 ###
 ### Defines testing module with hermione test runner.
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_TEST_HERMIONE_FOR
+###
 ### @example
 ###
 ###     TS_TEST_HERMIONE_FOR(path/to/module)
@@ -84,6 +88,8 @@ TS_TEST_PLAYWRIGHT_CMD=$TOUCH_UNIT \
 ###
 ### Defines testing module with playwright test runner.
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_TEST_PLAYWRIGHT_FOR
+###
 ### @example
 ###
 ###     TS_TEST_PLAYWRIGHT_FOR(path/to/module)
@@ -107,6 +113,7 @@ module TS_TEST_PLAYWRIGHT_FOR: _TS_TEST_BASE {
     _TS_TEST_FOR_CONFIGURE(playwright playwright.config.ts workspace_node_modules.tar)
 }
 
+### # internal
 module _TS_TEST_BASE: _BARE_UNIT {
     # ignore SRCS macro
     .ALIASES=SRCS=_NOOP_MACRO
@@ -160,6 +167,8 @@ macro _SETUP_INSTALL_NODE_MODULES_RECIPE() {
 ### Macro sets the path to configuration file of the test runner.
 ###
 ### - Path - path to the config file.
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/macros#ts-test-config
 macro TS_TEST_CONFIG(Path) {
     SET(TS_TEST_CONFIG_PATH $Path)
 }
@@ -172,6 +181,8 @@ _TS_TEST_EXTRA_SRCS_VALUE=
 ### Macro to define directories where the test source files should be located.
 ###
 ### - DIRS... - directories.
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/macros#ts-test-srcs
 macro TS_TEST_SRCS(DIRS...) {
     _GLOB(_TS_TEST_SRCS_VALUE ${suf=/**/*.$TS_TEST_EXTENSION:DIRS})
     SRCS($_TS_TEST_SRCS_VALUE)
@@ -217,18 +228,42 @@ macro NO_TS_TYPECHECK() {
     SET(_TS_TYPECHECK_VALUE none)
 }
 
+### @usage: TS_TYPECHECK(tsconfigFile)
+###
+### For check CSS, SASS, LESS for StyleLint. Must be inside of Module (TS_WEBPACK, TS_VITE, TS_NEXT, etc)
+###
+###    - tsconfigFile - by default tsconfig.json or value from TS_CONFIG macros.
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/macros#ts-typecheck
+###
+### @example:
+###
+###     TS_VITE()
+###         TS_TYPECHECK()
+###     END()
 macro TS_TYPECHECK(TS_CONFG="") {
     ENABLE(_TS_TYPECHECK_VALUE)
     SET(_TS_TYPECHECK_TSCONFIG $TS_CONFG)
 }
 
-
 # TS_STYLELINT
-
 _TS_STYLELINT_VALUE=no
 _TS_STYLELINT_CONFIG=
 _TS_STYLELINT_FILES=
 
+### @usage: TS_STYLELINT(configFile)
+###
+### For check CSS, SASS, LESS for StyleLint. Must be inside of Module (TS_WEBPACK, TS_VITE, TS_NEXT, etc)
+###
+###    - configFile - by default .stylelintrc.
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/macros#ts-stylelint
+###
+### @example:
+###
+###     TS_VITE()
+###         TS_STYLELINT(.stylelintrc)
+###     END()
 macro TS_STYLELINT(_CONFIG) {
     ENABLE(_TS_STYLELINT_VALUE)
     SET(_TS_STYLELINT_CONFIG $_CONFIG)
diff --git a/build/conf/ts/ts_tsc.conf b/build/conf/ts/ts_tsc.conf
index 2052a99ee1..7dd51b29ac 100644
--- a/build/conf/ts/ts_tsc.conf
+++ b/build/conf/ts/ts_tsc.conf
@@ -11,6 +11,8 @@ TS_TSC_CMD=$TOUCH_UNIT \
 ### The TypeScript/JavaScript library module, compiles TypeScript sources to JavaScript using tsc.
 ### Build results are JavaScript files, typings and source mappings (depending on local tsconfig.json settings).
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_TSC
+###
 ### @example
 ###
 ###     TS_TSC()
diff --git a/build/conf/ts/ts_vite.conf b/build/conf/ts/ts_vite.conf
index 14c0495017..ca6ff048f9 100644
--- a/build/conf/ts/ts_vite.conf
+++ b/build/conf/ts/ts_vite.conf
@@ -5,6 +5,8 @@ VITE_CONFIG_PATH=vite.config.ts
 ### Macro sets the config path for TS_VITE module.
 ###
 ### - ConfigPath - config path
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_VITE#ts-vite-config
 macro TS_VITE_CONFIG(ConfigPath) {
     SET(VITE_CONFIG_PATH $ConfigPath)
 }
@@ -17,10 +19,13 @@ VITE_OUTPUT_DIR=dist
 ### Macro sets the output directory name for TS_VITE module.
 ###
 ### - DirName - output directory name
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_VITE#ts-vite-output
 macro TS_VITE_OUTPUT(DirName) {
     SET(VITE_OUTPUT_DIR $DirName)
 }
 
+# TODO: remove me: https://st.yandex-team.ru/FBP-1678
 # tag:deprecated
 macro VITE_OUTPUT(DirName) {
     MESSAGE(WARNING "VITE_OUTPUT is deprecated, use TS_VITE_OUTPUT instead")
@@ -44,6 +49,8 @@ TS_VITE_CMD=$TOUCH_UNIT \
 ### The Vite bundle, bundles JavaScript code.
 ### Build results are packed as `output.tar`.
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_VITE
+###
 ### @example
 ###
 ###     TS_VITE()
diff --git a/build/conf/ts/ts_webpack.conf b/build/conf/ts/ts_webpack.conf
index 04eaf2421b..6cea71c0e3 100644
--- a/build/conf/ts/ts_webpack.conf
+++ b/build/conf/ts/ts_webpack.conf
@@ -5,6 +5,8 @@ WEBPACK_CONFIG_PATH=webpack.config.js
 ### Macro sets the config path for TS_WEBPACK module.
 ###
 ### - ConfigPath - config path
+###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_WEBPACK#ts-webpack-config
 macro TS_WEBPACK_CONFIG(ConfigPath) {
     SET(WEBPACK_CONFIG_PATH $ConfigPath)
 }
@@ -16,10 +18,12 @@ WEBPACK_OUTPUT_DIR=bundle
 ### Macro sets the output directory names (one at least) for TS_WEBPACK module.
 ###
 ### - DirNames - output directory names (one at least)
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_WEBPACK#ts-webpack-output
 macro TS_WEBPACK_OUTPUT(FirstDirName, DirNames...) {
     SET(WEBPACK_OUTPUT_DIR $FirstDirName $DirNames)
 }
 
+# TODO: remove me: https://st.yandex-team.ru/FBP-1678
 # tag:deprecated
 macro WEBPACK_OUTPUT(FirstDirName, DirNames...) {
     MESSAGE(WARNING "WEBPACK_OUTPUT is deprecated, use TS_WEBPACK_OUTPUT instead")
@@ -42,6 +46,8 @@ TS_WEBPACK_CMD=$TOUCH_UNIT \
 ### The Webpack bundle, bundles JavaScript code.
 ### Build results are packed as `output.tar`.
 ###
+### Documentation: https://docs.yandex-team.ru/frontend-in-arcadia/references/TS_WEBPACK
+###
 ### @example
 ###
 ###     TS_WEBPACK()