Skip to content

Commit f7bfb5b

Browse files
feat: Releasing v2.0.0
1 parent c8ed467 commit f7bfb5b

File tree

119 files changed

+352
-312
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+352
-312
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ install:
2222
npm i
2323
pre-commit install
2424

25+
2526
## Update dependencies
2627
update:
2728
pip install -U -q -r requirements-dev.txt

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ In order to keep consistency of the code snippets throughout the repo, you can u
8282
- Snippets are loaded in a nested fashion. Inner most `_snippets` with the same name will override general snippets in [`docs_template/_snippets/`](./docs_template/_snippets/).
8383
- All snippets in `*.md` and `*.ipynb` files are prefaced with `@@@`.
8484
```markdown
85-
@@@ relevanceai_dev_installation @@@
85+
@@@ relevanceai_installation , RELEVANCEAI_SDK_VERSION=RELEVANCEAI_SDK_VERSION @@@
8686
@@@ <SNIPPET_NAME>, <SNIPPET_PARAM_KEY_1>=<SNIPPET_PARAM_VALUE_1>, <SNIPPET_PARAM_KEY_2>=<SNIPPET_PARAM_VALUE_2>, ... @@@
8787
```
8888
- If you want to concatenate snippets, please concatenate using the following format.
@@ -99,6 +99,15 @@ In order to keep consistency of the code snippets throughout the repo, you can u
9999
100100
```
101101

102+
103+
## Converting notebooks to Markdown
104+
You can now convert notebooks to ReadMe Markdown either in [`rdmd`](https://rdmd.readme.io/) format or `block` format (which allows for interactive editing in ReadMe).
105+
106+
```zsh
107+
❯ sudo apt-get install pandoc ## or brew install pandoc
108+
❯ python src/rdme_sync/readme/nbconvert_rdmd.py -d -f "block"
109+
```
110+
102111
## 👩🏻‍💻 Syncing your Changes
103112

104113

@@ -123,9 +132,11 @@ In order to keep consistency of the code snippets throughout the repo, you can u
123132
```
124133
View your synced changes in ReadMe eg. https://docs.relevance.ai/v0.31.0/docs/quick-tour
125134

126-
## 👩🏻‍💻 Testing notebooks
127135

128136

137+
138+
## 👩🏻‍💻 Testing notebooks
139+
129140
11. Test the notebooks for changes. By default, the script will process all notebooks in the `docs` folder if no `--notebooks` specified. This script will output error logs to the file `readme_notebook_error_log.txt`
130141
```zsh
131142
❯ python src/tests/test_notebooks.py

config/readme-config-condensed.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ categories:
7979
quickstart: []
8080
quickstart-1: []
8181
quickstart-boilerplate: []
82+
relevance-ai-quickstart: []
8283
terminology:
8384
- documents-1
8485
vectors-and-vector-databases:

0 commit comments

Comments
 (0)