docs(api): bring back detailed api documentation (#5434)

api/package.json

@@ -31,9 +31,6 @@
     "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
     "precompile": "cross-var lerna run version --scope $npm_package_name --include-dependencies",
     "compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json",
-    "docs": "typedoc",
-    "docs:deploy": "gh-pages --dist docs/out",
-    "docs:test": "linkinator docs/out --silent && linkinator docs/*.md *.md --markdown --silent",
     "lint:fix": "eslint . --ext .ts --fix",
     "lint": "eslint . --ext .ts",
     "test:browser": "karma start --single-run",

api/src/experimental/index.ts

@@ -13,5 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/**
+ * Any exports here may change at any time and without warning
+ * @module @opentelemetry/api/experimental
+ */
+
 export { wrapTracer, SugaredTracer } from './trace/SugaredTracer';
 export { SugaredSpanOptions } from './trace/SugaredOptions';

api/src/index.ts

@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+/**
+ * @module @opentelemetry/api
+ */
+
 export { BaggageEntry, BaggageEntryMetadata, Baggage } from './baggage/types';
 export { baggageEntryMetadataFromString } from './baggage/utils';
 export { Exception } from './common/Exception';

api/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "entryPoints": [
+    "src/index.ts",
+    "src/experimental/index.ts"
+  ]
+}