Skip to content

Commit 90b2fc4

Browse files
teng-linclaude
andcommitted
docs: final documentation cleanup for 0.1.0
- Add folder README exception to naming conventions (CONTRIBUTING.md) - Remove premature v0.x→v1.x migration guide (python-api.md) - Simplify CLI description to "NotebookLM CLI" - Update Last Updated dates Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 866e5fb commit 90b2fc4

File tree

4 files changed

+5
-48
lines changed

4 files changed

+5
-48
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ Design decisions should be captured where they're most useful, not in separate d
7979
|------|--------|---------|
8080
| Root GitHub files | `UPPERCASE.md` | `README.md`, `CONTRIBUTING.md` |
8181
| Agent files | `UPPERCASE.md` | `CLAUDE.md`, `AGENTS.md` |
82-
| All docs/ files | `lowercase-kebab.md` | `getting-started.md`, `cli-reference.md` |
82+
| Folder README | `README.md` | `docs/README.md` (GitHub auto-renders) |
83+
| All other docs/ files | `lowercase-kebab.md` | `getting-started.md`, `cli-reference.md` |
8384
| Scratch files | `YYYY-MM-DD-context.md` | `2026-01-06-debug-auth.md` |
8485

8586
### Status Headers

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Documentation Folder
22

33
**Status:** Active
4-
**Last Updated:** 2026-01-06
4+
**Last Updated:** 2026-01-08
55

66
This folder contains all project documentation. AI agents must follow the rules in `/CONTRIBUTING.md`.
77

docs/python-api.md

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,10 @@
11
# Python API Reference
22

33
**Status:** Active
4-
**Last Updated:** 2026-01-07
4+
**Last Updated:** 2026-01-08
55

66
Complete reference for the `notebooklm` Python library.
77

8-
## Migration Guide (v0.x → v1.x)
9-
10-
### Breaking Changes
11-
12-
The service layer has been removed. Methods are now accessed directly on the client through namespaced APIs.
13-
14-
**Before (v0.x):**
15-
```python
16-
from notebooklm import NotebookLMClient
17-
from notebooklm.services import NotebookService, SourceService, ArtifactService
18-
19-
async with await NotebookLMClient.from_storage() as client:
20-
nb_svc = NotebookService(client)
21-
src_svc = SourceService(client)
22-
art_svc = ArtifactService(client)
23-
24-
notebooks = await nb_svc.list()
25-
source = await src_svc.add_url(nb_id, url)
26-
status = await art_svc.generate_audio(nb_id)
27-
```
28-
29-
**After (v1.x):**
30-
```python
31-
from notebooklm import NotebookLMClient
32-
33-
async with await NotebookLMClient.from_storage() as client:
34-
notebooks = await client.notebooks.list()
35-
source = await client.sources.add_url(nb_id, url)
36-
status = await client.artifacts.generate_audio(nb_id)
37-
```
38-
39-
### Method Mapping
40-
41-
| Old (v0.x) | New (v1.x) |
42-
|------------|------------|
43-
| `NotebookService(client).list()` | `client.notebooks.list()` |
44-
| `NotebookService(client).create(title)` | `client.notebooks.create(title)` |
45-
| `SourceService(client).add_url(...)` | `client.sources.add_url(...)` |
46-
| `SourceService(client).add_file(...)` | `client.sources.add_file(...)` |
47-
| `ArtifactService(client).generate_audio(...)` | `client.artifacts.generate_audio(...)` |
48-
| `ArtifactService(client).wait_for_completion(...)` | `client.artifacts.wait_for_completion(...)` |
49-
50-
---
51-
528
## Quick Start
539

5410
```python

src/notebooklm/notebooklm_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
)
6565
@click.pass_context
6666
def cli(ctx, storage):
67-
"""NotebookLM automation CLI.
67+
"""NotebookLM CLI.
6868
6969
\b
7070
Quick start:

0 commit comments

Comments
 (0)