Movatterモバイル変換


[0]ホーム

URL:


Skip to content
DEV Community
Log in Create account

DEV Community

Cover image for Improving the documentation user experience
SurrealDB profile imageMark Gyles
Mark Gyles forSurrealDB

Posted on • Originally published atsurrealdb.com

     

Improving the documentation user experience

At SurrealDB, we’re constantly iterating to enhance our product and provide the best possible experience for our users. Recently, we've gathered feedback through our channels and made updates we believe will improve both our documentation and your understanding ofmulti-model databases.

In this blog, we will be exploring these changes in more detail.

Improved documentation layout

We have modelled SurrealDB documentation as a multi-doc, which means it includes several points of entry, either through:SurrealDB,Surreal Cloud,Surrealist,SurrealML,SurrealQL,Tutorials,SDKs.

The improved navigation is to ensure that you can always find information from wherever you are in the documents.

Navigation

Sidebar overhaul

We've introduced a new expanded sidebar, allowing you to reference more information at a glance. We believe this will improve your documentation experience, and can’t wait to hear your feedback. In addition to this we have also improved search so you can find information much more easily. With that in mind, we have made the search faster including;

  • Added a new hotkeycmd + / orctrl + / for windows to ensure that you can always search with ease.
  • Improved search indexing and display, ensuring your queries are returned with the most relevant pages across the multi-doc.

Search bar

Search modal

Data-model section

Whether you’re coming from aDocument,Graph,Vector, orTime-series type database we’d like to help you build a better understanding of the ‘models’ needed to utilise and understand the capabilities of SurrealDB better. We’ve added a section that covers examples with popular databases such as MongoDB, Neo4J and Postgres.

Data models

Improved getting started guides

We understand that there is a lot of information and it can be overwhelming to get started with our offerings. We’re here to guide you along the way with our getting started guides.

We look forward to your continued feedback that enables us to improve the user experience with our documentation.

Top comments(0)

Subscribe
pic
Create template

Templates let you quickly answer FAQs or store snippets for re-use.

Dismiss

Are you sure you want to hide this comment? It will become hidden in your post, but will still be visible via the comment'spermalink.

For further actions, you may consider blocking this person and/orreporting abuse

The ultimate cloud database for tomorrow's applications

More fromSurrealDB

DEV Community

We're a place where coders share, stay up-to-date and grow their careers.

Log in Create account

[8]ページ先頭

©2009-2025 Movatter.jp