Aura Documentation

Caution

The experimental branch should NOT be used for PRs. Please raise any PR against the main branch.

Run Live Preview

npm install
npm start

Generate APOC Docs

1. Copy .env.example to .env and update the credentials to a valid aura instance.

2. Run npm run apoc to get a list of currently valid APOC functions/procedures and load them into modules/ROOT/partials/apoc-procedures.adoc.

Editing a Function or Procedure Description

Aura supports a subset of APOC Core, the documentation for which can be found [https://github.com/neo4j/docs-apoc](here).

To request a change to these descriptions, please ask in the #team-documentation channel on Slack.

Publication process

This repository is set up so that, when a PR is merged onto the main branch, the changes are automatically published on https://neo4j.com/docs/aura/.