Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/arcadedata/arcadedb-docs

ArcadeDB Documentation

https://github.com/arcadedata/arcadedb-docs

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

ArcadeDB Documentation

Basic Info
  • Host: GitHub
  • Owner: ArcadeData
  • License: cc0-1.0
  • Language: Python
  • Default Branch: main
  • Size: 12.6 MB
Statistics
  • Stars: 7
  • Watchers: 4
  • Forks: 26
  • Open Issues: 11
  • Releases: 0
Created about 5 years ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License

README.md

Netlify Status

ArcadeDB Documentation

Generate html and pdf documentation:

shell mvn generate-resources

Tip: You can build the documentation without installing Maven locally by using Docker: sh docker run --rm -v "$PWD":/docs -w /docs maven:3.8.8 mvn generate-resources

Documentation is generated under target/generated-docs folder

Serve documentation on local http server:

shell mvn jetty:run

Tip: You can also serve the documentation using Docker without installing Maven:

sh docker run --rm -it -p 8080:8080 -v "$PWD":/docs -w /docs maven:3.8.8 mvn jetty:run

Then open your browser to http://localhost:8080

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 <<anchor-id-example,related section>> 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.

Owner

  • Name: Arcade Data
  • Login: ArcadeData
  • Kind: organization
  • Email: info@arcadedata.com
  • Location: London, UK

The Company behind ArcadeDB and Arcade Trader

GitHub Events

Total
  • Issues event: 3
  • Watch event: 1
  • Delete event: 10
  • Issue comment event: 50
  • Push event: 90
  • Pull request review comment event: 56
  • Pull request review event: 86
  • Pull request event: 84
  • Fork event: 1
  • Create event: 17
Last Year
  • Issues event: 3
  • Watch event: 1
  • Delete event: 10
  • Issue comment event: 50
  • Push event: 90
  • Pull request review comment event: 56
  • Pull request review event: 86
  • Pull request event: 84
  • Fork event: 1
  • Create event: 17

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 22
  • Total pull requests: 194
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 5 days
  • Total issue authors: 9
  • Total pull request authors: 22
  • Average comments per issue: 2.5
  • Average comments per pull request: 1.31
  • Merged pull requests: 171
  • Bot issues: 1
  • Bot pull requests: 58
Past Year
  • Issues: 2
  • Pull requests: 64
  • Average time to close issues: about 2 hours
  • Average time to close pull requests: 4 days
  • Issue authors: 2
  • Pull request authors: 4
  • Average comments per issue: 0.5
  • Average comments per pull request: 0.73
  • Merged pull requests: 50
  • Bot issues: 0
  • Bot pull requests: 20
View more stats
Top Authors
Issue Authors
  • gramian (12)
  • lvca (2)
  • erickj (2)
  • obonilla66 (1)
  • scwagner (1)
  • gfinger (1)
  • dependabot[bot] (1)
  • ARYAN0KUMAR (1)
  • ShakeIQAdmin (1)
Pull Request Authors
  • gramian (94)
  • dependabot[bot] (58)
  • ChipNowacek (8)
  • robfrank (8)
  • erickj (4)
  • tetious (3)
  • tae898 (2)
  • arcade-player (2)
  • scwagner (2)
  • hielsnoppe (1)
  • grimace (1)
  • dinesh19aug (1)
  • JREastonMarks (1)
  • caochun (1)
  • finduspedersen (1)
Top Labels
Issue Labels
documentation (15) question (2) dependencies (1) java (1)
Pull Request Labels
dependencies (58) documentation (54) java (27) github_actions (11) dependency_approved (3)

Dependencies

.github/workflows/adocs-build.yml actions
  • actions/checkout v3 composite
  • peaceiris/actions-gh-pages v3 composite
  • tonynv/asciidoctor-action master composite
pom.xml maven