Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.

Conversation

@05st
Copy link
Contributor

@05st 05st commented Jun 10, 2025

Overall just a translation of the Rust tutorial. I also fixed a few things in the Rust tutorial.
For #510

@05st 05st requested a review from prrao87 June 10, 2025 17:55
Copy link
Contributor

@sdht0 sdht0 left a comment

Choose a reason for hiding this comment

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

My general observation is that the new page is duplicating a lot of the text from the Rust page.

@prrao87 Should we just use tabs for the language specific parts and make the rest common? Same as https://docs.kuzudb.com/get-started/#quick-start

@prrao87
Copy link
Contributor

prrao87 commented Jun 10, 2025

@sdht0 I've thought about this, and the main thing to keep in mind is user personas: a user who reads the Python code may not care about Rust, or Java, so they won't even notice that there's repetition. Having a dedicated page for each tutorial, clearly accessible in the sidebar for each user persona (Python developer, JavaScript developer, etc.) is paramount. Moving things into tabs makes it harder to discover in the docs, both in the sidebar and via the search box on top. We also don't know the implications of how LLM bots crawling our docs in the future may behave if we deeply embed the examples inside tabs.

IMO repetition is fine from our (developer) perspective too - there are enough nuances with each programming language that there will be minor differences in code and subsections. Maintaining separate dedicated pages allows us the flexibility as maintainers, too.

@sdht0
Copy link
Contributor

sdht0 commented Jun 10, 2025

Alright makes sense.

Another option is have a common file but programmatically generate the separate pages when deploying. That is of course beyond the scope of this PR.

Copy link
Contributor

@prrao87 prrao87 left a comment

Choose a reason for hiding this comment

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

I reverted the sidebar link because we have other tutorials in Python (notebooks) to link to. Other than that, looks good to go!

@prrao87 prrao87 merged commit d224373 into main Jun 11, 2025
1 check passed
@prrao87 prrao87 deleted the python-tutorial branch June 11, 2025 13:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants