{"id":20374367,"url":"https://github.com/arcadedata/arcadedb-docs","last_synced_at":"2025-04-12T07:12:32.207Z","repository":{"id":38375198,"uuid":"383530539","full_name":"ArcadeData/arcadedb-docs","owner":"ArcadeData","description":"ArcadeDB Documentation","archived":false,"fork":false,"pushed_at":"2025-04-09T19:01:17.000Z","size":12856,"stargazers_count":6,"open_issues_count":7,"forks_count":25,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-12T07:12:23.191Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArcadeData.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-06T16:18:56.000Z","updated_at":"2025-04-09T19:00:41.000Z","dependencies_parsed_at":"2024-05-10T21:26:29.412Z","dependency_job_id":"aa75460d-06ff-4e07-8bac-feb90f1be4d9","html_url":"https://github.com/ArcadeData/arcadedb-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadedb-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadedb-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadedb-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcadeData%2Farcadedb-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArcadeData","download_url":"https://codeload.github.com/ArcadeData/arcadedb-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248530571,"owners_count":21119600,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T01:24:01.444Z","updated_at":"2025-04-12T07:12:32.196Z","avatar_url":"https://github.com/ArcadeData.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Netlify Status](https://api.netlify.com/api/v1/badges/eef44996-0500-4b34-bd74-c9043079e547/deploy-status)](https://app.netlify.com/sites/laughing-saha-bb44e9/deploys)\n\n# ArcadeDB Documentation\n\nGenerate html and pdf documentation:\n\n```shell\nmvn generate-resources\n```\n\nDocumentation is generated under `target/generated-docs` folder\n\nServe documentation on local http server:\n\n```shell\nmvn jetty:run\n```\n\nthen open the browser to http://localhost:8080\n\n## Documentation Conventions\n\nTo maintain consistency across the documentation, please follow these naming conventions:\n\n### File Naming Conventions\n\nAll documentation files should use lowercase naming with hyphens between words:\n\n- ✅ `lowercase-with-hyphens.adoc`\n- ❌ `CamelCase.adoc`\n- ❌ `UPPERCASE.adoc`\n- ❌ `snake_case.adoc`\n\n### Document ID Anchors\n\nDocument anchors should also use lowercase with hyphens:\n\n```asciidoc\n[[anchor-id-example]]\n== Section Title\n```\n\n### Cross-References\n\nCross-references should use the lowercase anchor IDs:\n\n```asciidoc\nSee the \u003c\u003canchor-id-example,related section\u003e\u003e for more information.\n```\n\n## Validation\n\nThe documentation includes automated validation to ensure consistency and correctness.\n\n### Running the Validator\n\nRun the documentation validator locally:\n\n```shell\npython docs-validator.py\n```\n\nThis validator checks:\n1. File naming conventions (lowercase with hyphens)\n2. Anchor naming conventions (lowercase with hyphens)\n3. Cross-reference validity (all references point to existing anchors)\n4. Orphaned pages (pages not referenced by other pages)\n\n### Continuous Integration\n\nThe documentation validator runs automatically on GitHub when changes are pushed or pull requests are created. This ensures that documentation standards are maintained consistently.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farcadedata%2Farcadedb-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farcadedata%2Farcadedb-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farcadedata%2Farcadedb-docs/lists"}