memgraph / documentation

The official documentation for Memgraph open-source graph database.

Memgraph Documentation

This repository contains the source files and various generators for the Memgraph documentation available at memgraph.com/docs.

🛠️ Run docs locally

To run the documentation website locally, you will need to install:

• Node.js version >= 16.0.0 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed.
• pnpm

Run the development server

To preview your changes as you edit the files, you can run a local development server that will serve your website and reflect the latest changes.

First install node and pnpm. After that, clone this repository:

git clone https://github.com/memgraph/documentation.git

Change the working directory to the one of the cloned repository and install the dependencies:

pnpm i

Now, you can start the server:

pnpm dev

Open the URL http://localhost:3000/docs in your browser.

🚧 Build

Install the dependencies:

pnpm i

Build the website:

pnpm build

Contents will be generated within the /build directory.

Test your build locally:

pnpm start

✍️ Contribute

We are grateful for any community contributions to the documentation, as they are the best way of improving the overall user experience. If at any point you believe that something is misleading, could be worded better, or is missing additional information, then please feel free to make a pull request or report an issue.

Contributing guide

If you want to change the documentation, create a new branch and make the appropriate changes. Then, create a pull request to merge these changes into the main branch.

The pull request should describe the changes it's proposing and all checks must be completed.

Add an appropriate label to the PR, either status: draft if you are still working on the PR, or status: ready if the PR is ready for review.

When the PR is reviewed and approved, the label will be changed to status: ship it and merged into the main by the repo admins.

If the PR requires changes, the label will be changed to status: change. Address the comments and change the documentation appropriately, then re-request a review and change the label to status: ready again.

documentation's Issues

Check for broken links

Now that all of the content has been migrated from Docusarus we need to check if there are any broken links.

YouTube video is missing from /data-visualization/user-manual

On the page /data-visualization/user-manual Youtube video is not embedded, and it should be.

Change navigation features

We need to:

1. Make the main menu start as a collapsed
2. Remove previous/next pages links
3. Temporarily disable Question? Give us feedback and Edit this page links

Update Docker docs if needed

I've added some new segments related to Docker workflow in Docusarus repo (memgraph/docs#1008).

@vpavicic take a look if you can use it inside Nextra docs.

Add Memgraph 2.10.1 and Lab v2.8.1 to Release notes

Add the new entries from memgraph/docs#1004 and memgraph/docs#1005 to the Release notes.

Update links in Release notes

In Release notes, we have a bunch of links that go to .md files. We should update them all.

Add neighbors query module docs

Once the new MAGE is out, we need to add the docs for query-modules/cpp/neighbors. They are, at the moment, on the old docs site.

Update docs styling

We need to update CSS code so that the syle is aligned with the proposed Figma design.

Adding sharp package for Image Optimization

We need to decide if we want to add shap package for image optimization.

ready - started server on 0.0.0.0:3000, url: http://localhost:3000
Warning: For production Image Optimization with Next.js, the optional 'sharp' package is strongly recommended. Run 'yarn add sharp', and Next.js will use it automatically for Image Optimization.
Read more: https://nextjs.org/docs/messages/sharp-missing-in-production

Decide where the redirects will go

We need to redirect the following old URLs to new destinations:

• https://memgraph.com/docs/memgraph/connect-to-memgraph
• https://memgraph.com/docs/memgraph/how-to-guides
• https://memgraph.com/docs/memgraph/tutorials
• https://memgraph.com/docs/memgraph/under-the-hood

Remove references to Tutorials and How-to and other similar overview pages

We no longer have a Tutorials overview page, but we often reference it in the docs. The same goes for the How-to overview page, Under the hood overview page, etc. References to those pages should be removed from the docs.

Add the info about subgraphs

Please check which algorithms don’t have this information:

Add the same information to algorithms with this info to the new docs, and link appropriately.
Also ask Fićo if collections and map, llm_util, text, date, label algorithms can also be run on subgraphs

Update First steps with Memgraph docs

We need to update First steps with Memgraph (/getting-started/first-steps-with-memgraph) docs.

Migrate older version of the docs to the Netlify archive

With Memgraph 2.9 around the corner, we will have seven versions of the docs in the dropdown. I suggest that we move all versions prior to 2.6. to the Netlify archive at https://memgraph-archive-docs.netlify.app/.

@katarinasupe I think that you are the perfect person for this task :)

Girvan-Newman algorithm for community detection, networkx.guide

When I was doing my final project at university on topic: centrality and community detection algorithms, I came across this article: https://networkx.guide/algorithms/community-detection/girvan-newman/ .I found the above article very confusing because of this pseudocode part:

REPEAT
    LET n BE number of edges in the graph
    FOR i=0 to n-1
        LET B[i] BE betweenness centrality of edge i
        IF B[i] > max_B THEN
            max_B = B[i]
            max_B_edge = i
        ENDIF
    ENDFOR
    remove edge i from graph
UNTIL number of edges in graph is 0

I understood this in the way that the algorithm removes edges until number of edges in graph is 0, that would mean that at the end every node in graph will be its own community. After i looked source code of Networkx, I found that this is correct, but also incomplete. This is their implementation:

while g.number_of_edges() > 0:
        yield _without_most_central_edges(g, most_valuable_edge)

def _without_most_central_edges(G, most_valuable_edge):
    original_num_components = nx.number_connected_components(G)
    num_new_components = original_num_components
    while num_new_components <= original_num_components:
        edge = most_valuable_edge(G)
        G.remove_edge(*edge)
        new_components = tuple(nx.connected_components(G))
        num_new_components = len(new_components)
    return new_components

So every time new community is found, algorithm will "save it", it won't return just a case where every node is its own community.
Although this is mentioned in the "Method output" part of the article, I found this pseudocode very confusing and incomplete.
Also, example with illustration of a graph with nodes A, B, C, D, E and F at the begging of the article says that algorithm stops after removing edge that connects C and D, because we have come to the point where every edge has the same betweenness centrality. Based on Networkx implementation, algorithm won't stop after that. It will be just a sequence of communities at a particular level (iteration) of the algorithm.

Add information about Memgraph + GNN

Add more info about Memgraph + GNNs in MAGE docs. Info can be found on Notion/Slack.

Replace PNG logo with SVG version

We need to replace the PNG logo in the navbar with an SVG version.

Update comparison between Memgraph and Neo4j

Update the comparison between memgraph and neo4j in the cypher manual (https://memgraph.com/docs/querying/differences-in-cypher-implementations)

@gvolfing will help with a list, the rest compare docs

Update MAGE docs based on old Docusarus docs

We have to update some of the MAGE docs. The docs that need to be merged into this repo:

• memgraph/docs#999
• memgraph/docs#996
• memgraph/docs#997

Update/add/expand documentation about Cypher string operators

Under Other features we talk about String operators, but we have no examples or code that show them in action. Could we add it here or perhaps add it to the MATCH documentation page?

Add Lima to the list of supported installation methods

Memgrpah can be installed on MacOS using Lima . We need to add that to the documentation.

Force light mode

We need to force the light mode until we have the dark mode ready.

Add redirects for GQLAlchemy documentation

Documentation for GQLAlchemy will now be at

Once the docs are merged (memgraph/gqlalchemy#259) we will need to create redirects from old URLs to new ones.

Add another relationship to go in the opposite direction

Would be better if we created the relationships in the opposite direction as well.
https://memgraph.com/docs/cypher-manual/cypher-query-language

Migrate redirects from Docusarus to Nextra

In Docusarus, we have a lot of redirects in place. We need to see if we are going to keep them.

Check all of the memgr.ph links

We use http://memgr.ph shortened links in the codebase to help users with different errors. We need to check all of them and update them if needed.

Add steps to recover copy/paste in Lab in browser

If not yet added, add the steps to recover the copy/paste feature as explained on Discord: https://discord.com/channels/842007348272169002/890969266600423504/1140923289376665601

Create more examples for exists function

Give better example usage of exists function. (with NOT)
Compare with queries from other dbs.

Add the logo

We need to add the Memgraph logo to the navbar.

Update GQLAlcehmy related links

GQLAchemy documentation is now located at https://memgraph.github.io/gqlalchemy/. We need to update the links in the documentation.

Fix styling for code blocks

Code blocks should use #F9F9F9 for the background color.

Table on the page /data-visualization/graph-style-script/built-in-elements is not rendered as it should

Table with colors in the /data-visualization/graph-style-script/built-in-elements does not show colors. It outputs the HTML code.

Add missing algorithms to the overview page

We need to add missing algos to the list in the docs/advanced-algorithms/available-algorithms. We need to add text, date, and label.

Add a missing information about how query-caches work

Explain how query caches work and in what scenarios queries will be cached.
For context, there are flags: --query-max-plans=1000 and --query-plan-cache-ttl=60.
Related: https://github.com/memgraph/memgraph/discussions/713

Implement dark mode

We need to enable the mode selector and add CSS code for dark mode.

Update docker commands where needed - replace -v mg_lib:/var/lib/memgraph with --name memgraph

We need to see in which documentation pages we need to update or rewrite docker commands that have -v mg_lib:/var/lib/memgraph. In some cases, this should be updated with --name memgraph.

Fox example, in pages\getting-started\first-steps-with-memgraph.mdx, we should update it, and in pages\getting-started\install-memgraph\docker.mdx: we should give additional explanations.

Extend sys-admin and/or dev-ops related docs pages

• IP forward sysctl config

Add MAGE to Release notes

Add the new MAGE release to the Release notes - memgraph/docs#1007

Broken link for Memgraph Lab

On the page docs/getting-started#download-and-install-memgraph, there is a broken link for Memgrpah Lab.

Create CONTRIBUTING guide

We need a contributing guide for our documentation repository.

Add under the hood content about `SerializationError`

Buda will write a Notion file explaining the SerializationError, which can happen when importing data so that users better understand the concepts of deadlock and learn how to handle serialization errors on their side on write queries.

Document logging in create custom query module tutorial

Users will probably need logging while creating their custom query module, so it would be great to document examples logging in the query module tutorial. Part of the answer, content for docs, is at StackOverflow.

Add footer to the docs

We need to add the footer to the docs.

Update README file for the repo

We need to update the README file for this repo with instructions on how to build and contribute to the docs.

Link the storage memory page from min/rec system req

Create a sentence here where the system requirements are mentioned https://memgraph.com/docs/memgraph/installation

and link it to the Storage memory usage page

Document meaning of notes upon Memgraph binary installation

When a user installs the Memgraph binary, they get a note about missing Python packages. It can be unclear to the user what this means and what to do next. We should document it better.
Here is the report: https://discord.com/channels/842007348272169002/842008652377751582/1124012471733190767
Here is the discussion to add to docs: https://memgraph.slack.com/archives/CSR01RS80/p1688056540942609

Add more contex on WITH in cypher manual

How the WITH is used can result in unbounded MATCHES, which slows down queries and intoduces peak memory usages etc.

Sample:

MATCH (x:..)
WITH x               /// x passed 
MATCH (y:....) // not using x
WITH x, y.         //x should be passed on multiple times until you use it again.
MATCH (z:...)
WITH x
MATCH (x) // the same x from the first match.

If you do not pass x multiple times, it will scan all nodes and run the last MATCH on multiple nodes, resulting in slow execution and big memory usage.

Implement Algolia search

We need to add the Algolia search to the documentation.

Update favicon

New favicon needs to be uploaded.

Add more information on logging.

• Add info on how to change logging
• Add info about volumes
• Add info about what levels of logging are there and what they include

Context look comments on the question: https://stackoverflow.com/questions/76375954/how-to-know-if-create-query-failed-in-memgraph-through-neo4j-java-driver?noredirect=1#comment134733384_76375954