Add docs code testing & documentation syntax changes (#196)

- Creates testing files `md_testing.py` and `md_testing.js` for testing
python and nodejs code in markdown files in the documentation
This listens for HTML tags as well: `<!--[language] code code
code...-->` will create a set-up file to create some mock tables or to
fulfill some assumptions in the documentation.
- Creates a github action workflow that triggers every push/pr to
`docs/**`
- Modifies documentation so tests run (mostly indentation, some small
syntax errors and some missing imports)

A list of excluded files that we need to take a closer look at later on:
```javascript
const excludedFiles = [
  "../src/fts.md",
  "../src/embedding.md",
  "../src/examples/serverless_lancedb_with_s3_and_lambda.md",
  "../src/examples/serverless_qa_bot_with_modal_and_langchain.md",
  "../src/examples/youtube_transcript_bot_with_nodejs.md",
];
```
Many of them can't be done because we need the OpenAI API key :(.
`fts.md` has some issues with the library, I believe this is still
experimental?

Closes #170

---------

Co-authored-by: Will Jones <willjones127@gmail.com>
This commit is contained in:
Tevin Wang
2023-06-28 11:07:26 -07:00
committed by GitHub
co-authored by Will Jones
parent 0f58bd7af2
commit b731a6aed9
16 changed files with 1173 additions and 49 deletions
+4 -4
View File
@@ -23,7 +23,7 @@ We'll cover the basics of using LanceDB on your local machine in this section.
=== "Python"
```python
import lancedb
uri = "~/.lancedb"
uri = "data/sample-lancedb"
db = lancedb.connect(uri)
```
@@ -35,7 +35,7 @@ We'll cover the basics of using LanceDB on your local machine in this section.
```javascript
const lancedb = require("vectordb");
const uri = "~./lancedb";
const uri = "data/sample-lancedb";
const db = await lancedb.connect(uri);
```
@@ -102,7 +102,7 @@ Once created, you can open a table using the following code:
If you forget the name of your table, you can always get a listing of all table names:
```javascript
console.log(db.tableNames());
console.log(await db.tableNames());
```
## How to add data to a table
@@ -118,7 +118,7 @@ After a table has been created, you can always add more data to it using
=== "Javascript"
```javascript
await tbl.add([vector: [1.3, 1.4], item: "fizz", price: 100.0},
await tbl.add([{vector: [1.3, 1.4], item: "fizz", price: 100.0},
{vector: [9.5, 56.2], item: "buzz", price: 200.0}])
```