Skip to content

update readme #817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: console
Choose a base branch
from
Open

update readme #817

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74f5a6c
update readme
AlexicaWright Sep 29, 2025
0de876c
Merge branch 'console' into update-readme
AlexicaWright Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,35 @@
= 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

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`.

== 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!**
Expand Down