Repository navigation
docs: build the Antora component as a site of its own, check it on every docs change - #115
Merged
Merged
Conversation
…ery docs change docs.arcadedb.com does not publish the component yet (ArcadeData/arcadedb-docs#505), and the test workflows ignore docs/** and *.adoc, so nothing built the pages and a docs-only PR had no check. - docs/antora-playbook.yml: standalone site with the UI bundle and asciidoc attributes of the arcadedb-docs playbook; attribute-missing warn and failure level warn. - docs.yml: Antora 3.2.1 (same as arcadedb-docs) on push/PR touching docs/, uploads docs-site. - The 13 xref:arcadedb:: links become {arcadedb-docs-url}/<page> (attribute in antora.yml); the 10 target pages and 4 anchors were checked live on docs.arcadedb.com, a bogus page gives 404. - README, ci.adoc and CLAUDE.md describe the workflow and the link rule. Closes #114 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Antora resolves a bare .. from the working directory (CI: /home/runner/work/arcadedb-python, not a git repository); a path that starts with ./ is relative to the playbook file. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…edb-python) Pages is enabled with source "GitHub Actions" (build_type workflow); the github-pages environment allows main only. arcadedata.com is the org Pages domain (behind Cloudflare; arcadedata.com/arcadedb-docs/ already serves a project site), so the project site lands at https://arcadedata.com/arcadedb-python/. The build job uploads the Pages artifact on main only; the deploy job runs actions/deploy-pages v5.0.1. site.url set for the sitemap. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
tae898
changed the title
…dedb-python This reverts commit 7816049. The site belongs at docs.arcadedb.com/arcadedb-python (ArcadeData/arcadedb-docs#505), not arcadedata.com/arcadedb-python; Pages is disabled again on this repository and the github-pages environment it created is removed. The Docs workflow keeps building the component and attaching the preview artifact. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
tae898
changed the title
8 of 10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #114
The docs in
docs/are an Antora component, but nothing built them: docs.arcadedb.com does not publish the component yet (ArcadeData/arcadedb-docs#505), and the test workflows ignoredocs/**and*.adoc.docs/antora-playbook.ymlantora-playbook.ymlof ArcadeData/arcadedb-docs, so pages render as on docs.arcadedb.com.attribute-missing: warnand failure levelwarn(production useserror)..github/workflows/docs.ymldocs/, and uploads the site as thedocs-siteartifact. For a docs-only pull request, this is the only check.xref:arcadedb::...links to{arcadedb-docs-url}/<page>antora.yml. All 10 target pages and 4 anchors were checked live on docs.arcadedb.com (a bogus page gives 404, so the check is not vacuous). The links keep working when #505 adds the component to the main site.development/ci.adoc,CLAUDE.mdLocal build, from the repository root:
npx -p @antora/cli@3.2.1 -p @antora/site-generator@3.2.1 antora docs/antora-playbook.yml, then opendocs/build/site/index.html.This PR does not host the site: it belongs at docs.arcadedb.com/arcadedb-python, which ArcadeData/arcadedb-docs#505 adds.
The repo's pre-commit hooks pass on the changed files (pretty-format-yaml, actionlint, the old-package-name check).
🤖 Generated with Claude Code