Skip to content

Docs: rework tutorials and add widget screenshots - #494

Merged
FlorentinD merged 1 commit into
mainfrom
gds-260-improve-docs
Oct 30, 2026
Merged

FlorentinD merged 1 commit into
mainfrom
gds-260-improve-docs

Conversation

@FlorentinD

Copy link
Copy Markdown
Collaborator

Tutorials:

  • Rename the "Jupyter notebooks" page to "Tutorials"
  • Add "Open in Colab" badges and a committed creds.env.example template
    (env-file based credentials, including NEO4J_DB)
  • Rework the Neo4j tutorial: use render_widget, link to our API reference
    instead of NVL, and drop the embedded HTML outputs (12.9 MB -> 31 KB)
  • Switch the GDS tutorial to render_widget

Docs images:

  • Generate every tutorial/README image as a full widget screenshot with the
    headless-browser harness, replacing the bare graph SVGs
  • Add screenshots to the GDS and getting-started tutorials (previously none)
  • Make the Snowflake screenshots reproducible (built via from_gql_create)
  • Add an opt-in GDS image spec (skipped unless NEO4J_URI is set)
  • Share examples/example_graph.png between the README and the Neo4j tutorial

Tutorials:
- Rename the "Jupyter notebooks" page to "Tutorials"
- Add "Open in Colab" badges and a committed creds.env.example template
  (env-file based credentials, including NEO4J_DB)
- Rework the Neo4j tutorial: use render_widget, link to our API reference
  instead of NVL, and drop the embedded HTML outputs (12.9 MB -> 31 KB)
- Switch the GDS tutorial to render_widget

Docs images:
- Generate every tutorial/README image as a full widget screenshot with the
  headless-browser harness, replacing the bare graph SVGs
- Add screenshots to the GDS and getting-started tutorials (previously none)
- Make the Snowflake screenshots reproducible (built via from_gql_create)
- Add an opt-in GDS image spec (skipped unless NEO4J_URI is set)
- Share examples/example_graph.png between the README and the Neo4j tutorial
@FlorentinD
FlorentinD merged commit ce520ec into main Oct 30, 2026
14 checks passed
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