chore: docs improvement

trust0-project · Nov 5, 2024 · 72b425f · 72b425f
1 parent b338356
commit 72b425f
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -27,10 +27,6 @@
 
 - [RIDBTypes](namespaces/RIDBTypes/README.md)
 
-## Classes
-
-- [RIDB](classes/RIDB.md)
-
 ## Variables
 
 - [SchemaFieldType](variables/SchemaFieldType.md)
diff --git a/docs/variables/SchemaFieldType.md b/docs/variables/SchemaFieldType.md
@@ -34,4 +34,4 @@ An enumeration of schema field types.
 
 ## Defined in
 
-[ts/src/index.ts:205](https://github.com/elribonazo/RIDB/blob/1c63aad9f4ff19e9fbbdb4c1cc728eac5263e72c/ts/src/index.ts#L205)
+[ts/src/index.ts:281](https://github.com/elribonazo/RIDB/blob/b338356f29436de6c6994d2e281d605a10f29517/ts/src/index.ts#L281)
diff --git a/ts/src/index.ts b/ts/src/index.ts
@@ -51,6 +51,7 @@ class MySimplePlugin extends RIDBTypes.BasePlugin {
 
 
 /**
+ * @packageDocumentation
  * Represents a RIDB (Rust IndexedDB) instance.
  * This is the main class exposed by the RIDB Storage sdk and is used to create a database instance.
  *
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ An enumeration of schema field types.

		## Defined in

		[ts/src/index.ts:205](https://github.com/elribonazo/RIDB/blob/1c63aad9f4ff19e9fbbdb4c1cc728eac5263e72c/ts/src/index.ts#L205)
		[ts/src/index.ts:281](https://github.com/elribonazo/RIDB/blob/b338356f29436de6c6994d2e281d605a10f29517/ts/src/index.ts#L281)
-Original file line number
+Diff line change
@@ Expand Up / @@ -51,6 +51,7 @@ class MySimplePlugin extends RIDBTypes.BasePlugin { @@
     /**
+     * @packageDocumentation
      * Represents a RIDB (Rust IndexedDB) instance.
      * This is the main class exposed by the RIDB Storage sdk and is used to create a database instance.
      *
@@ Expand Down @@