Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@royendo
Copy link
Contributor

@royendo royendo commented Nov 3, 2025

Screenshot 2025-11-03 at 12 16 54 Screenshot 2025-11-03 at 12 16 58

Based on the code, can get very specific to the page level IE for get-started and guides we can show different pages!

Checklist:

  • Covered by tests
  • Ran it and it works as intended
  • Reviewed the diff before requesting a review
  • Checked for unhandled edge cases
  • Linked the issues it closes
  • Checked if the docs need to be updated. If so, create a separate Linear DOCS issue
  • Intend to cherry-pick into the release branch
  • I'm proud of this work!

@royendo royendo requested a review from ericpgreen2 November 3, 2025 17:19
@royendo
Copy link
Contributor Author

royendo commented Nov 3, 2025

Thoughts? (instead of a Developer Docs and User Docs tab)

Also, we can default to tabs open with this approach as its not as overwhelming.

@royendo royendo requested review from ericokuma and removed request for ericokuma November 3, 2025 17:59
@ericpgreen2
Copy link
Contributor

Thoughts?

Currently, I'm not sure the toggle works:

  1. It makes it hard to link to a specific state. For example, we should be able to easily link to docs.rilldata.com/<business-users>/getting-started.
  2. It's possible to get into a seemingly broken state by navigating to the "Reference" page, then attempting to go to a "Business User" docs page:
    image
  3. Aesthetically, it feels a little off. As is, the weight of the "Developer" / "Business User" toggle makes it feel like you're on one page, then clicking "Docs" might lead you to another page. But that's not the case.

Here's a proposal:

  • We have two tabs: "Developers" and "User Guide"
  • We add a namespace for the docs on each of these pages: docs.rilldata.com/develop/... and docs.rilldata.com/guide/...
  • We rename the Developer "Guides" to "Tutorials" to avoid the naming overlap
  • Any content that is used on both pages gets placed in a common code directory, and we import it as a component into both Developer and User Guide pages. The file structure could be something like:
docs/
     developers/
       get-started/
       build/
       deploy/
       integrate/
     users/
       get-started/
       explore/
       manage/
     shared/
       overview.mdx
       concepts/
       feature-explanations/

Thoughts on that?

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.

3 participants