Using api-extractor now, bunch of ts-doc tags & build process linting/updating

Author: toptobes

.gitignore

@@ -132,4 +132,7 @@ dist
 .idea
 creds.json
 .DS_Store
-build.zip
+build.zip
+
+temp
+tsdoc-metadata.json

DEVGUIDE.md

@@ -65,11 +65,22 @@ If a new tag really, really, needs to be added, it can be done by adding a new e
 format, and updating the `assertTestsEnabled` function. However, this should be done sparingly, as it can make the
 test suite harder to manage.
 
-### Linting
+## Linting
 Run `npm run lint` to run ESLint.
 ESLint will point out any formatting and code quality issues it finds.
 You should try to run `npm run lint` before committing to minimize risk of regressions.
 
+## Building the library
+At the moment, you need to be using a unix-like system to build the library, as it uses a small shell script,
+which can be found in `scripts/build.sh`, and run manually enough on Windows if necessary.
+
+To build it, just run `npm run build`, which does the following:
+- Deletes the `dist` directory
+- Updates the versioning file (`src/version.ts`)
+- Runs `tsc` to compile the TypeScript files & resolves path aliases w/ `tsc-alias`
+- Uses `api-extractor` to generate the API report & generate a rolled-up `.d.ts` file
+- Deletes any extraneous `.d.ts` files
+
 ## Building API Reference Documentation
 API Documentation of this library is generated using [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown)
 

README.md

@@ -93,7 +93,7 @@ Next steps:
 
 `astra-db-ts`'s abstractions for working at the data and admin layers are structured as depicted by this diagram:
 
-![Class hierarchy diagram](assets/imgs/class-hierarchy.png)
+![Class hierarchy diagram](etc/imgs/class-hierarchy.png)
 
 Here's a small admin-oriented example: