Skip to content

Notebooks: W&B Release - #3199

Open
ngrayluna wants to merge 32 commits into
mainfrom
workspaces_notebooks
Open

ngrayluna wants to merge 32 commits into
mainfrom
workspaces_notebooks

Conversation

@ngrayluna

@ngrayluna ngrayluna commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Notes

Thought process behind docs: Provide enough info for users to use Notebooks. Link to marimo docs for more info.

Considerations:

  • Getting started guide: Consider different example...it's easy to do, but maybe not that useful?

@mintlify

mintlify Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
wandb 🟢 Ready View Preview Sep 16, 2026, 9:51 PM

Page Change
Configure Notebook Added · +10 −0
Create Notebook Added · +32 −0
Data Files Added · +17 −0
Developer Tools Added · +11 −0
Edit Notebook Added · +20 −0
Get Started Added · +11 −0
Manage Compute Added · +12 −0
Manage Packages Environments Added · +10 −0
Run Notebooks Added · +14 −0
Share Notebooks Added · +12 −0
No preview available (2)
File Change
docs.json Changed · +16 −0
models/notebooks.md Added · +6

Updated 2026-09-08 19:39:39 UTC for deployment · e27bc7c.

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Readability impact

No changed page had a scorable before-and-after version, so there is no readability delta to report. See the per-page details below.

Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR.

Human readability

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
models/notebooks.mdx 10.6 n/a
models/notebooks/configure-notebook.mdx 9.2 n/a
models/notebooks/create-notebook.mdx 6.1 n/a
models/notebooks/data-files.mdx 8.5 n/a
models/notebooks/developer-tools.mdx 8.5 n/a
models/notebooks/edit-notebook.mdx 7.5 n/a
models/notebooks/get-started-v2.mdx 9.7 n/a
models/notebooks/get-started.mdx 8.0 n/a
models/notebooks/manage-packages-environments.mdx 9.0 n/a
models/notebooks/reactive-info.mdx 8.0 n/a
models/notebooks/run-notebook-cells.mdx 8.2 n/a

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
models/notebooks/reactive-info.mdx 2
models/notebooks/developer-tools.mdx 3
models/notebooks.mdx 2
models/notebooks/get-started.mdx 2
models/notebooks/data-files.mdx 3
models/notebooks/edit-notebook.mdx 2
models/notebooks/create-notebook.mdx 3
models/notebooks/manage-packages-environments.mdx 2
models/notebooks/configure-notebook.mdx 2
models/notebooks/get-started-v2.mdx 2

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 35154558686

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-workspaces-notebooks.mintlify.site

@wandb-docs-pr-writer

Copy link
Copy Markdown
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 81.6%, saving 522.2 KB.

Filename Before After Improvement Visual comparison
images/notebooks/variable_dependencies.png 639.7 KB 117.5 KB 81.6% View diff

@wandb-docs-pr-writer

Copy link
Copy Markdown
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 80.3%, saving 1.2 MB.

Filename Before After Improvement Visual comparison
images/notebooks/hello_world_scratchpad.png 424.0 KB 82.5 KB 80.6% View diff
images/notebooks/hello_world_tracing.png 423.9 KB 90.2 KB 78.7% View diff
images/notebooks/hello_world_logs.png 379.2 KB 76.0 KB 80.0% View diff
images/notebooks/hello_world_dev_panel.png 284.5 KB 49.3 KB 82.7% View diff

1 image did not require optimisation.

@wandb-docs-pr-writer

Copy link
Copy Markdown
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 82.2%, saving 269.0 KB.

Filename Before After Improvement Visual comparison
images/notebooks/hello_package_management.png 327.4 KB 58.4 KB 82.2% View diff

5 images did not require optimisation.

@ngrayluna ngrayluna changed the title Notebooks: basic outline Notebooks: Docs Sep 16, 2026
@ngrayluna
ngrayluna marked this pull request as ready for review September 16, 2026 21:37
@ngrayluna
ngrayluna requested a review from a team as a code owner September 16, 2026 21:37
@ngrayluna ngrayluna changed the title Notebooks: Docs Notebooks: W&B Release Sep 16, 2026
@@ -0,0 +1,63 @@
---

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are editor preferences (marimo-inherited) staying? If no, Noah to remove "Configure editor preferences".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant