From 74f5a6c03db703d10245d26d7fd3aa87e6c4575e Mon Sep 17 00:00:00 2001 From: AlexicaWright <49636617+AlexicaWright@users.noreply.github.com> Date: Mon, 29 Sep 2025 10:24:39 +0200 Subject: [PATCH] update readme --- README.adoc | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index e9fc1ed27..392734ffa 100644 --- a/README.adoc +++ b/README.adoc @@ -1,10 +1,17 @@ = Aura Documentation -== Run Live Preview -[source] -npm install -npm start +This repository contains the source content published at neo4j.com/docs/aura. +Lead writers are Jessica Wright and Ffion Quick. + +Documentation requests can be made in the following ways: + +* Via link:https://trello.com/b/GUoYB9pB/team-documentation[our Trello wall] +* Via the #team-documentation Slack channel +* By raising a PR in this repository + +This docset consists of `.adoc` files and is structured as described in the `content-nav.adoc` file. +It contains *two* exceptions, *APOC* and the *API specification*. == Generate APOC Docs @@ -12,6 +19,17 @@ npm start 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`. +== API specification + +Info on how this works and where it lives. + +== Run Live Preview + +[source] +npm install +npm start + + == Create/Destroy an Aura instance **NOTE: Remember to destroy Aura instances when no longer in use!**