Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
5522b00
Experimental Platform split
Simran-B Aug 8, 2025
55dfbbf
WIP: Don't attempt to navigate to path but different version between …
Simran-B Aug 8, 2025
78caf59
Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…
Simran-B Sep 4, 2025
d7a9917
WIP: Navigation
Simran-B Sep 4, 2025
1085cbd
Fix link
Simran-B Sep 4, 2025
599f2ce
Test: Links between Platform and Core
Simran-B Sep 4, 2025
4237c0c
Try to exclude aliases in link check
Simran-B Sep 4, 2025
0fb6d21
chore: update greens/reds
palashkaria Oct 2, 2025
b40bfc3
Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…
Simran-B Oct 7, 2025
549bb30
Hugo config: Temporarily disable aliases and exclude legacy versions
Simran-B Oct 13, 2025
c643c10
Preliminary support for versioned subfolders
Simran-B Oct 13, 2025
29c4763
Content re-organization and product renaming
Simran-B Oct 13, 2025
a228b4d
Make core root folder not show cards for now
Simran-B Oct 13, 2025
2e21560
CircleCI: Increase time between config fetching attempts
Simran-B Oct 13, 2025
ccb0050
WIP: New navigation scheme with inline version selector
Simran-B Oct 13, 2025
8241b8e
chore: update logo, tweak colors
palashkaria Oct 2, 2025
e72d42f
Merge remote-tracking branch 'origin/color-update' into DOC-761
Simran-B Oct 13, 2025
48f41a5
Theme: Add Urbanist font
Simran-B Oct 2, 2025
edd5d81
Re-enable all core versions
Simran-B Oct 13, 2025
538a871
Try Urbanist as font for headlines
Simran-B Oct 13, 2025
62ea103
CircleCI: Account for versions.yaml change when loading versions
Simran-B Oct 13, 2025
440b218
Add optgroup to version selector with label "Version"
Simran-B Oct 13, 2025
7ad8671
Set sans-serif as fallback font for headlines
Simran-B Oct 13, 2025
46b4617
Change tags due to renaming
Simran-B Oct 14, 2025
f43d573
Add EE tag tooltip for legacy content
Simran-B Oct 14, 2025
8c1ed34
Remove unnecessary tags
Simran-B Oct 14, 2025
24b8aa7
Move About ArangoDB out of versioned folder to ArangoDB top-level and…
Simran-B Oct 14, 2025
f703f67
Add brand colors as CSS variables
Simran-B Oct 14, 2025
d6ee8be
Use Urbanist font for lead paragraph and card titles
Simran-B Oct 14, 2025
f26daae
Try electric lime as color for active nav items
Simran-B Oct 14, 2025
4974ac7
Squashed commit of the following:
Simran-B Oct 24, 2025
79bb7f9
Unrelated consistency changes
Simran-B Oct 24, 2025
8076e73
Squashed commit of the following:
Simran-B Oct 24, 2025
69921ba
Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…
Simran-B Oct 24, 2025
25eac9f
Update tag tooltips
Simran-B Oct 24, 2025
3737b48
Fix tab name in Graph Analytics
Simran-B Oct 24, 2025
73909a4
Graph Intelligence -> Graphs also in menu
Simran-B Oct 24, 2025
f5621c4
ArangoGraph -> AMP in oasisctl generator
Simran-B Oct 24, 2025
298e66a
Change cloud banner alt text
Simran-B Oct 24, 2025
11b874d
Rename AI Services back to AI Suite
Simran-B Oct 24, 2025
620e441
Squashed commit of the following:
Simran-B Oct 25, 2025
ae5de8c
New domain, Arango team/support
Simran-B Oct 25, 2025
235cc18
Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…
Simran-B Oct 28, 2025
aa716cc
Whitespace control and typo
Simran-B Oct 29, 2025
c39f6de
Simplify logic for in-development warning with a flag in versions.yaml
Simran-B Oct 30, 2025
93bc5ac
Fix and refactor breadcrumbs
Simran-B Oct 30, 2025
d8b0e6a
Set metadata for search engines
Simran-B Oct 30, 2025
78dfbbe
Toolchain: Adjust oasisctl generator for new docs structure and impro…
Simran-B Oct 31, 2025
f644e17
Move drivers & integrations under Ecosystem (#816)
nerpaula Nov 3, 2025
65d2717
Attribute-based theming (#821)
Simran-B Nov 4, 2025
17e9b62
Docs homepage content (#819)
Simran-B Nov 4, 2025
bf4dd36
Update Inkeep config
Simran-B Nov 5, 2025
6b33eb5
Toolchain: generate-oasisctl workflow no longer needs arangodb-X_XX (…
Simran-B Nov 5, 2025
86f1ed3
DOC-812 | New Query Editor & AQLizer feature page (#810)
Simran-B Nov 5, 2025
b9fa610
Data Platform | Add dedicated K8s page and detailed descriptions (arc…
nerpaula Nov 5, 2025
bff23ac
DOC-797 | Natural language to AQL service (txt2aql / AQLizer) (#794)
nerpaula Nov 5, 2025
e7484d4
DOC-800 | New GraphRAG UI steps (#805)
nerpaula Nov 5, 2025
c7f31a0
WIP: New navigation
Simran-B Nov 5, 2025
e07a7c2
Fix versioned submenu visibility
Simran-B Nov 5, 2025
0c2e63f
Merge branch 'DOC-761' of https://github.com/arangodb/docs-hugo into …
Simran-B Nov 5, 2025
954266c
Fix active state for hard navigation and better expand widget
Simran-B Nov 5, 2025
b1393bb
Replace versions in arangodb links on the client-side
Simran-B Nov 6, 2025
f5d33cb
Adjust cards on root page of 3.12 and 3.13
Simran-B Nov 6, 2025
2f149bf
Fix go to homepage
Simran-B Nov 6, 2025
55e9645
Rework mobile menu toggle
Simran-B Nov 6, 2025
0cb14ce
Fix version and error handling
Simran-B Nov 6, 2025
8fded54
Hide mobile navigation on click
Simran-B Nov 6, 2025
7d5c428
Data Platform & AI Suite | October release notes (#824)
nerpaula Nov 6, 2025
f7f8be0
DOC-815 | MCP Server (#820)
nerpaula Nov 6, 2025
97d035c
Leave the navigation closed by default on mobile
Simran-B Nov 6, 2025
2b81842
Restructuring and version for Data Platform (#823)
Simran-B Nov 6, 2025
42c930d
Rename gen-ai.md service to ai-orchestrator.md
Simran-B Nov 6, 2025
9a4f76f
Don't link to version root page, don't change page when on ArangoDB root
Simran-B Nov 6, 2025
b73c825
Change menu title AMP API -> API
Simran-B Nov 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion .circleci/base_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ workflows:
when: { equal: [ release, << pipeline.parameters.workflow >> ] }
jobs:
- plain-build:
url: https://docs.arangodb.com
url: https://docs.arango.ai
- deploy:
deploy-args: "--prod"
requires:
Expand Down
8 changes: 4 additions & 4 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ parameters:
type: string
default: "undefined"

arangodb-3_13:
arangodb-4_0:
type: string
default: "undefined"

Expand Down Expand Up @@ -87,7 +87,7 @@ jobs:
command: |
mkdir -p .circleci && cd .circleci
fetched=false
for i in $(seq 1 6); do
for i in $(seq 1 5); do
echo ""
res=$(curl -fsS https://api.github.com/repos/arangodb/docs-hugo/contents/.circleci?ref=$CIRCLE_SHA1) || curlStatus=$?
if [[ -z "${curlStatus:-}" ]]; then
Expand All @@ -103,7 +103,7 @@ jobs:
fi
unset curlStatus
unset jqStatus
sleep 10
sleep 60
done
if [[ "$fetched" = false ]]; then
echo "Failed to fetch download URLs"
Expand All @@ -116,7 +116,7 @@ jobs:

python3 generate_config.py \
--workflow << pipeline.parameters.workflow >> \
--arangodb-branches << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-3_13 >> \
--arangodb-branches << pipeline.parameters.arangodb-3_10 >> << pipeline.parameters.arangodb-3_11 >> << pipeline.parameters.arangodb-3_12 >> << pipeline.parameters.arangodb-4_0 >> \
--arangodb-branch << pipeline.parameters.arangodb-branch >> \
--release-type << pipeline.parameters.release-type >> \
--docs-version << pipeline.parameters.docs-version >> \
Expand Down
4 changes: 2 additions & 2 deletions .circleci/generate_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

## Load versions
versions = yaml.safe_load(open("versions.yaml", "r"))
versions = sorted(versions, key=lambda d: d['name'])
versions = sorted(versions["/arangodb/"], key=lambda d: d['name'])


print(f"Loaded versions {versions}")
Expand Down Expand Up @@ -389,7 +389,7 @@ def workflow_commit_generated_download_data(config):
def workflow_release_launch_command(config):
shell = "\
export ENV=\"circleci\"\n \
export HUGO_URL=https://docs.arangodb.com\n \
export HUGO_URL=https://docs.arango.ai\n \
export HUGO_ENV=release\n \
export GENERATORS=''\n"

Expand Down
9 changes: 3 additions & 6 deletions CIRCLECI.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Invoke Args:
### Deploy a plain build to production

To update the live documentation independently of an ArangoDB release, for
example, because of changes to the ArangoGraph docs or to publish documentation
example, because of changes to the Data Platform docs or to publish documentation
improvements before the next ArangoDB release, follow the steps below.

1. Go to CircleCI and select the `docs-hugo` project.
Expand All @@ -48,7 +48,7 @@ improvements before the next ArangoDB release, follow the steps below.
(The `release-type` is `docs` by default)

The docs-only release workflow runs a **plain build** of the documentation and
deploys to production at <https://docs.arangodb.com> without approval step.
deploys to production at <https://docs.arango.ai> without approval step.

## Example generation

Expand Down Expand Up @@ -181,7 +181,7 @@ The ArangoDB release workflow includes the following jobs:
- a release branch and pull request is created with the generated content, which
needs to be reviewed and merged on GitHub
- once merged, the workflow in CircleCI needs to be approved to start
deploying to production at <https://docs.arangodb.com>
deploying to production at <https://docs.arango.ai>

If any of the examples or generated content fails, the workflow fails as well.
The build report can be found in the `generate-summary` check on GitHub.
Expand Down Expand Up @@ -219,9 +219,6 @@ Invoke Args:
| Parameter type | Name | Value |
|:---------------|:-----|:------|
| string | `workflow` | `generate-oasisctl` |
| string | `arangodb-3_10` | `arangodb/enterprise-preview:3.10-nightly` |
| string | `arangodb-3_11` | `arangodb/enterprise-preview:3.11-nightly` |
| string | `arangodb-3_12` | `arangodb/enterprise-preview:devel-nightly` |
| string | `generators` | `oasisctl` |
| boolean | `commit-generated` | `true` |
| boolean | `create-pr` | `true` |
Expand Down
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
- 3.10:
- 3.11:
- 3.12:
- 3.13:
- 4.0:
90 changes: 60 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# ArangoDB Documentation
# Arango Documentation

This repository contains the source files of the ArangoDB documentation as
published on [docs.arangodb.com](https://docs.arangodb.com/).
This repository contains the source files of the Arango documentation as
published on [docs.arango.ai](https://docs.arango.ai/).

The ArangoDB documentation is licensed under Apache-2.0.
The Arango documentation is licensed under Apache-2.0.
See [LICENSE](LICENSE) for details.

## Contribute
Expand Down Expand Up @@ -276,7 +276,7 @@ requiring to manually apply changes to different versions as necessary.
- `public/` - Default output directory for the generated site (not committed)
- `resources/` - Holds the various cached resources that are generated by Hugo
when using `hugo serve`
- `themes/` - Folder for Hugo themes, containing the customized ArangoDB docs theme
- `themes/` - Folder for Hugo themes, containing the customized Arango docs theme
- `toolchain/` - Folder for the docs toolchain tools and scripts
- `arangoproxy/` - Source code of the arangoproxy web server
- `docker/` - The Docker container and compose files, with two sets of
Expand Down Expand Up @@ -367,8 +367,8 @@ Inner shortcode
Tags let you display badges, usually below a headline.

This is mainly used for pointing out if a feature is only available in the
ArangoDB Platform, the ArangoGraph Insights Platform, or both.
See [Environment remarks](#environment-remarks) for details.
AI Suite, the Data Platform, the Arango Managed Platform (AMP), or multiple
of them. See [Environment remarks](#environment-remarks) for details.

It is also used for [Edition remarks](#edition-remarks) in content before
version 3.12.5.
Expand Down Expand Up @@ -429,13 +429,32 @@ Available attributes:
- `class`: CSS classes to apply
- `style`: CSS inline styles to apply

#### Icons

If a web interface uses icons, especially as buttons without labels, use
the `icon` shortcode to inline an SVG file for a visual reference as
demonstrated below:

```markdown
Select all nodes ({{< icon "select-all" >}}), then right-click.
```

Icons are supposed to supplement the text, i.e. not be embedded in sentences.
They are hidden from screen readers.

To add new icons to the toolchain, save them to `site/content/images/icons/`.
They are referenced by file name (without extension) in the shortcode.

SVG icon files should not define the attributes `width`, `height`, `aria-hidden`,
and `focusable` on the `<svg>` tag.

#### Keyboard shortcuts

To document hotkeys and key combinations to press in a terminal or graphical
user interface, use the `kbd` shortcode:

```markdown
Hit {{< kbd "Ctrl Return" >}} respectively {{< kbd "Cmd Return" >}} to run the query.
Press {{< kbd "Ctrl Return" >}} respectively {{< kbd "Cmd Return" >}} to run the query.
```

#### Cards
Expand Down Expand Up @@ -526,8 +545,8 @@ The following shortcodes also exist but are rarely used:
- Avoid overly long link labels, such as entire sentences.

- Use relative links for cross-references to other documentation pages, e.g.
`../drivers/js/_index.md` instead of `/3.12/drivers/js/_index.md` or
`https://docs.arangodb.com/3.12/drivers/js/`.
`../../data-platform/_index.md` instead of `/data-platform/_index.md` or
`https://docs.arango.ai/data-platform/`.

- Avoid **bold** and *italic* markup in headlines. If you have to use it, then
prefer `**bold**` and `*italic*` over `__bold__` and `_italic_` because the
Expand Down Expand Up @@ -570,8 +589,10 @@ The following shortcodes also exist but are rarely used:
- _DB-Server_, not ~~dbserver~~, ~~db-server~~, ~~DBserver~~ (unless it is a code value)
- _Coordinator_ (uppercase C)
- _Agent_, _Agency_ (uppercase A)
- _ArangoGraph Insights Platform_ and _ArangoGraph_ for short, but not
~~Oasis~~, ~~ArangoDB Oasis~~, or ~~ArangoDB Cloud~~
- _Arango Managed Platform (AMP)_ and _AMP_ for short, but not
~~Oasis~~, ~~ArangoDB Oasis~~, ~~ArangoDB Cloud~~, ~~ArangoGraph Insights Platform~~, or ~~ArangoGraph~~
- _Arango Data Platform_, _Arango AI Data Platform_, and _AI Suite_, but not
~~Arango AI Services Data Platform~~, ~~Arango AI Suite Data Platform~~, ~~AI Services~~, or ~~GenAI Suite~~
- _Deployment mode_ (single server, cluster, etc.), not ~~deployment type~~

- Never capitalize the names of executables or code values, e.g. write
Expand All @@ -586,7 +607,7 @@ For external links, use standard Markdown. Clicking these links automatically
opens them in a new tab:

```markdown
[ArangoGraph Insights Platform](https://dashboard.arangodb.cloud)
[Arango Managed Platform (AMP)](https://dashboard.arangodb.cloud)
```

For internal links, use relative paths to the Markdown files. Always link to
Expand Down Expand Up @@ -674,25 +695,24 @@ deprecated features in the same manner with `Deprecated in: ...`.
### Environment remarks

Pages and sections about features that are only available in certain environments
such as the ArangoDB Platform, the ArangoGraph Insight Platform, or the
ArangoDB Shell should indicate where they are available using the `tag` shortcode.
such as in ArangoDB Shell should indicate where they are available using the
`tag` shortcode.

In the unified Platform and ArangoGraph but not in the Core:
Features exclusive to the Data Platform, AI Data Platform,
Arango Managed Platform (AMP), and ArangoDB generally don't need to be tagged
because they are in dedicated parts of the documentation. However, if there are
subsections with different procedures, each can be tagged accordingly.

```markdown
{{< tag "ArangoDB Platform" "ArangoGraph" >}}
```

In the unified Platform only:
In the AI Data Platform only:

```markdown
{{< tag "ArangoDB Platform" >}}
{{< tag "AI Data Platform" >}}
```

In ArangoGraph only:
In the Arango Managed Platform (AMP) only:

```markdown
{{< tag "ArangoGraph" >}}
{{< tag "AMP" >}}
```

In the ArangoDB Shell but not the server-side JavaScript API:
Expand All @@ -719,7 +739,16 @@ Enterprise Edition features should indicate that the Enterprise Edition is
required using a tag. Use the following include in the general case:

```markdown
{{< tag "ArangoDB Enterprise Edition" "ArangoGraph" >}}
{{< tag "ArangoDB Enterprise Edition" "AMP" >}}
```

### Experimental remark

Features that are available for testing but may still change or get removed and
should thus not be used in production can be tagged as follows:

```markdown
{{< tag "Experimental" >}}
```

### Add lead paragraphs
Expand Down Expand Up @@ -757,8 +786,8 @@ Start off by finding a file name. It should be:

Note that the file name is independent of what will show in the navigation or
what will be used as headline for that page. The file name will be used as
part of the final URL, however. For example, `3.12/aql/examples.md` will become
`http://docs.arangodb.com/3.12/aql/examples/`.
part of the final URL, however. For example, `arangodb/3.12/aql/examples.md`
will become `http://docs.arango.ai/arangodb/3.12/aql/examples/`.

Create a new file with the file name and a `.md` file extension. Open the file
in a text editor (Visual Studio Code is recommended). Add the following
Expand Down Expand Up @@ -793,8 +822,9 @@ Otherwise, the following steps are necessary for moving content:

The URL of a page is derived from the file name and the parent folders, with
special handling for sections (folders with a `_index.md` file).
For example, `3.12/aql/operators.md` becomes the URL path `/3.12/aql/operators/`,
and `3.12/aql/functions/_index.md` becomes `/3.12/aql/functions/`.
For example, `arangodb/3.12/aql/operators.md` becomes the URL path
`/arangodb/3.12/aql/operators/`, and `arangodb/3.12/aql/functions/_index.md`
becomes `/arangodb/3.12/aql/functions/`.

If you rename a file, from `section/old-name.md` to `section/new-name.md` for
instance, make sure to add a redirect for the old URL by adding the following to
Expand Down Expand Up @@ -1233,7 +1263,7 @@ db._document("collection/does_not_exist"); // xpError(ERROR_ARANGO_DOCUMENT_NOT_
```

This will make the example generation continue despite the error. See
[Error codes and meanings](https://docs.arangodb.com/stable/develop/error-codes-and-meanings/)
[Error codes and meanings](https://docs.arango.ai/arangodb/stable/develop/error-codes/)
for a list of all error codes and their names. If a unexpected error is raised,
then the example generation will abort with an error.

Expand Down
22 changes: 14 additions & 8 deletions site/config/_default/config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
baseURL: "https://docs.arangodb.com"
baseURL: "https://docs.arango.ai"
languageCode: "en-us"
title: "ArangoDB Documentation"
title: "Arango Documentation"
theme: "arangodb-docs-theme"
timeout: "200000000"

Expand All @@ -21,12 +21,18 @@ module:

# Version folders can be ignored temporarily for faster local builds
# of a single version (here: 3.12)
# - excludeFiles:
# - 3.10/*
# - 3.11/*
# - 3.13/*
# source: content
# target: content
- source: content
target: content
excludeFiles:
# - arangodb/3.10/*
# - arangodb/3.11/*
# - arangodb/4.0/*

- source: content/arangodb/3.12
target: content/arangodb/stable

- source: content/arangodb/4.0
target: content/arangodb/devel

markup:
highlight:
Expand Down
42 changes: 0 additions & 42 deletions site/content/3.10/_index.md

This file was deleted.

Loading