https://github.com/arcadedata/arcadedb-docs
ArcadeDB Documentation
https://github.com/arcadedata/arcadedb-docs
Last synced: 9 months ago
JSON representation
ArcadeDB Documentation
- Host: GitHub
- URL: https://github.com/arcadedata/arcadedb-docs
- Owner: ArcadeData
- License: cc0-1.0
- Created: 2021-07-06T16:18:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-09T19:01:17.000Z (9 months ago)
- Last Synced: 2025-04-12T07:12:23.191Z (9 months ago)
- Language: Python
- Size: 12.3 MB
- Stars: 6
- Watchers: 4
- Forks: 25
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/laughing-saha-bb44e9/deploys)
# ArcadeDB Documentation
Generate html and pdf documentation:
```shell
mvn generate-resources
```
Documentation is generated under `target/generated-docs` folder
Serve documentation on local http server:
```shell
mvn jetty:run
```
then open the browser to http://localhost:8080
## Documentation Conventions
To maintain consistency across the documentation, please follow these naming conventions:
### File Naming Conventions
All documentation files should use lowercase naming with hyphens between words:
- ✅ `lowercase-with-hyphens.adoc`
- ❌ `CamelCase.adoc`
- ❌ `UPPERCASE.adoc`
- ❌ `snake_case.adoc`
### Document ID Anchors
Document anchors should also use lowercase with hyphens:
```asciidoc
[[anchor-id-example]]
== Section Title
```
### Cross-References
Cross-references should use the lowercase anchor IDs:
```asciidoc
See the <> for more information.
```
## Validation
The documentation includes automated validation to ensure consistency and correctness.
### Running the Validator
Run the documentation validator locally:
```shell
python docs-validator.py
```
This validator checks:
1. File naming conventions (lowercase with hyphens)
2. Anchor naming conventions (lowercase with hyphens)
3. Cross-reference validity (all references point to existing anchors)
4. Orphaned pages (pages not referenced by other pages)
### Continuous Integration
The documentation validator runs automatically on GitHub when changes are pushed or pull requests are created. This ensures that documentation standards are maintained consistently.