Add Validation docs to the site#544
Merged
Merged
Conversation
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
- Add DOMPurify sanitization for defense-in-depth HTML sanitization (Showdown v1.9.0's sanitize=true is incomplete against iframe/object/data URIs) - Prevent race condition from multiple clicks by marking state as 'loading' before firing requests, avoiding parallel request chains Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
We have `check-links` now.
We don't embed code from this project.
The script was created for a conference in 2024 and is not longer needed.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 790dc918b0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
JuliaEvseeva
approved these changes
May 25, 2026
There was a problem hiding this comment.
Pull request overview
This PR updates the spine.io Hugo site to pull newer upstream documentation modules (including Validation docs) and aligns repository tooling/configuration by introducing shared agent conventions, modernized Gradle wrapper/props, and a revamped link-check workflow.
Changes:
- Bump Hugo module dependencies for
documentation/docsandvalidation/docs. - Replace legacy link-check workflow with a new
Check Linksworkflow and add Gradle wrapper validation. - Apply shared
config/agent scaffolding and related repo hygiene (remove unused scripts/tasks/submodules, update docs and IDE metadata).
Reviewed changes
Copilot reviewed 108 out of 124 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| site/go.sum | Updates Hugo module checksum entries (now includes new pseudo-versions). |
| site/go.mod | Bumps Hugo module pseudo-versions for documentation + validation docs. |
| site/assets/js/pages/oss-licenses.js | Updates license-fetch JS; adds “loading” state and optional DOMPurify sanitization. |
| sh | Removed unused helper shell script. |
| README.md | Updates repo description and prerequisites text. |
| gradlew.bat | Updates Windows Gradle wrapper script content. |
| gradle/wrapper/gradle-wrapper.properties | Updates wrapper distribution and adds wrapper download validation settings. |
| gradle.properties | Adds Gradle runtime settings (JDK detection/download, JVM args, etc.). |
| CODE_OF_CONDUCT.md | Adds Contributor Covenant Code of Conduct. |
| CLAUDE.md | Reduces to a thin wrapper referencing AGENTS.md. |
| buildSrc/build.gradle.kts | Removes buildSrc build script. |
| build.gradle.kts | Removes unused buildAll task docs/registration; keeps Hugo-related Exec tasks. |
| AGENTS.md | Adds agent-orientation and safety guidance entry point. |
| .junie/guidelines.md | Adds JetBrains Junie agent guidelines. |
| .idea/misc.xml | Updates IDEA project metadata (entry points, nullability defaults, JDK config). |
| .idea/live-templates/User.xml | Adds user live template set. |
| .idea/live-templates/Spine.xml | Adds Spine live template set. |
| .idea/live-templates/README.md | Documents how to install/configure the live templates. |
| .idea/dictionaries/common.xml | Updates IDE dictionary entries. |
| .idea/copyright/TeamDev_Open_Source.xml | Updates Apache license URL in the IntelliJ copyright notice. |
| .idea/codeStyles/Project.xml | Updates IDE code style configuration (line separator, builder methods, etc.). |
| .gitmodules | Replaces _code submodules with config submodule. |
| .gitignore | Expands ignore rules; adds shared tooling/agent-related ignores. |
| .github/workflows/proof-links.yml | Removes legacy “Proof Links” workflow. |
| .github/workflows/gradle-wrapper-validation.yml | Adds Gradle wrapper validation workflow. |
| .github/workflows/check-links.yml | Adds new Hugo+Lychee based link-check workflow with caching and site autodetection. |
| .github/copilot-instructions.md | Adds GitHub Copilot repo instructions referencing AGENTS.md / .agents. |
| .codecov.yml | Removes Codecov configuration file. |
| .claude/settings.json | Adds Claude Code tool permission configuration and hooks. |
| .claude/commands/write-docs.md | Adds Claude command for writing docs via writer skill. |
| .claude/commands/update-copyright.md | Adds Claude command for copyright refresh via skill. |
| .claude/commands/run-build.md | Adds Claude command for selecting the right build based on changes. |
| .claude/commands/review-docs.md | Adds Claude command to run documentation review skill. |
| .claude/commands/pre-pr.md | Adds Claude command to run pre-PR checklist skill. |
| .claude/commands/move-files.md | Adds Claude command for safe moves/renames. |
| .claude/commands/java-to-kotlin.md | Adds Claude command for Java→Kotlin conversion skill. |
| .claude/commands/dependency-update.md | Adds Claude command for dependency update skill. |
| .claude/commands/bump-version.md | Adds Claude command for bump-version skill. |
| .claude/commands/bump-gradle.md | Adds Claude command for bump-gradle skill. |
| .claude/agents/review-docs.md | Adds reviewer-agent definition for docs review. |
| .claude/agents/kotlin-review.md | Adds reviewer-agent definition for Kotlin/Java review. |
| .claude/agents/dependency-audit.md | Adds reviewer-agent definition for dependency audits. |
| .agents/version-policy.md | Adds versioning policy reference for agent workflows. |
| .agents/testing.md | Adds testing guidance for agents. |
| .agents/tasks/setup-cross-tool-agent-instructions.md | Adds a durable task plan describing consolidation of agent instructions. |
| .agents/tasks/README.md | Adds documentation for .agents/tasks/ task-plan format and lifecycle. |
| .agents/tasks/prompt-caching-org.md | Adds a durable task plan about prompt caching practices. |
| .agents/tasks/prohibit-automatic-commits.md | Adds a durable task plan enforcing no-autocommit rule. |
| .agents/tasks/api-discovery.md | Adds a durable task plan for API discovery tooling. |
| .agents/skills/writer/SKILL.md | Adds writer skill definition and documentation conventions. |
| .agents/skills/writer/assets/templates/kotlin-java-example.md | Adds writer template for Kotlin/Java tabbed examples. |
| .agents/skills/writer/assets/templates/kdoc-example.md | Adds writer template for KDoc examples. |
| .agents/skills/writer/assets/templates/doc-page.md | Adds writer template for doc page structure. |
| .agents/skills/writer/agents/openai.yaml | Adds UI metadata for writer skill. |
| .agents/skills/version-bumped/SKILL.md | Adds version-bumped guard skill definition. |
| .agents/skills/update-copyright/tests/test_update_copyright.py | Adds tests for the copyright update script. |
| .agents/skills/update-copyright/SKILL.md | Adds update-copyright skill definition. |
| .agents/skills/update-copyright/scripts/update_copyright.py | Adds script to update copyright headers from IntelliJ profiles. |
| .agents/skills/update-copyright/agents/openai.yaml | Adds UI metadata for update-copyright skill. |
| .agents/skills/review-docs/SKILL.md | Adds documentation review skill definition. |
| .agents/skills/pre-pr/SKILL.md | Adds pre-PR checklist skill definition. |
| .agents/skills/move-files/SKILL.md | Adds move-files skill definition. |
| .agents/skills/move-files/agents/openai.yaml | Adds UI metadata for move-files skill. |
| .agents/skills/kotlin-review/SKILL.md | Adds Kotlin/Java review skill definition. |
| .agents/skills/java-to-kotlin/SKILL.md | Adds Java→Kotlin conversion skill definition. |
| .agents/skills/java-to-kotlin/agents/openai.yaml | Adds UI metadata for java-to-kotlin skill. |
| .agents/skills/dependency-update/SKILL.md | Adds dependency update skill definition. |
| .agents/skills/dependency-update/agents/openai.yaml | Adds UI metadata for dependency-update skill. |
| .agents/skills/dependency-audit/SKILL.md | Adds dependency audit skill definition. |
| .agents/skills/bump-version/SKILL.md | Adds bump-version skill definition (with commit authorization section). |
| .agents/skills/bump-version/agents/openai.yaml | Adds UI metadata for bump-version skill. |
| .agents/skills/bump-gradle/SKILL.md | Adds bump-gradle skill definition (with commit authorization section). |
| .agents/skills/bump-gradle/agents/openai.yaml | Adds UI metadata for bump-gradle skill. |
| .agents/skills/api-discovery/SKILL.md | Adds api-discovery skill definition. |
| .agents/scripts/update-copyright.sh | Adds post-edit hook script to refresh copyright headers. |
| .agents/scripts/sanitize-source-code.sh | Adds post-edit hook script to sanitize whitespace/blank lines. |
| .agents/scripts/publish-version-gate.sh | Adds pre-tool gate blocking risky Gradle invocations without version bump. |
| .agents/scripts/protect-version-file.sh | Adds hook blocking direct edits to version.gradle.kts. |
| .agents/scripts/pre-pr-gate.sh | Adds hook blocking gh pr create unless pre-PR checks passed for HEAD. |
| .agents/scripts/api-discovery/update-sibling | Adds safe helper to fast-forward pull sibling repos on default branch only. |
| .agents/scripts/api-discovery/README.md | Documents api-discovery scripts implementation. |
| .agents/scripts/api-discovery/extract-sources | Adds script to extract -sources.jar into a shared cache. |
| .agents/scripts/api-discovery/discover | Adds script to resolve source locations for Maven artifacts. |
| .agents/scripts/api-discovery/clean-cache | Adds script to prune api-discovery extraction cache. |
| .agents/scripts/api-discovery/.gitignore | Ignores per-developer api-discovery workspace-root override file. |
| .agents/safety-rules.md | Adds safety rules, including commit/history-write prohibition policy. |
| .agents/running-builds.md | Adds guidance for which Gradle command to run based on change type. |
| .agents/refactoring-guidelines.md | Adds minimal refactoring guidance. |
| .agents/quick-reference-card.md | Adds quick-reference summary (notably commit/history rules). |
| .agents/project.template.md | Adds template for per-repo .agents/project.md. |
| .agents/project.md | Adds repo-specific overview/architecture notes for spine.io site. |
| .agents/project-structure-expectations.md | Adds general project structure expectations doc. |
| .agents/project-overview.md | Adds generic project overview doc. |
| .agents/memory/reference/cache-warm-window.md | Adds reference memory entry on caching warm window. |
| .agents/memory/reference/anthropic-api-caching.md | Adds reference memory entry on Anthropic API caching pattern. |
| .agents/memory/reference/.gitkeep | Keeps reference memory directory tracked. |
| .agents/memory/README.md | Documents team memory structure and write protocol. |
| .agents/memory/project/.gitkeep | Keeps project memory directory tracked. |
| .agents/memory/MEMORY.md | Adds team memory index. |
| .agents/memory/feedback/copilot-review-request.md | Adds feedback memory entry about requesting Copilot reviews programmatically. |
| .agents/memory/feedback/.gitkeep | Keeps feedback memory directory tracked. |
| .agents/jvm-project.md | Adds shared JVM project requirements doc. |
| .agents/documentation-tasks.md | Adds documentation task guidelines. |
| .agents/documentation-guidelines.md | Adds documentation/commenting guidelines. |
| .agents/common-tasks.md | Adds common-task guidance. |
| .agents/coding-guidelines.md | Adds coding guidelines summary. |
| .agents/advanced-safety-rules.md | Adds advanced safety rules. |
| .agents/_TOC.md | Adds .agents/ documentation table of contents. |
| _code/EMBEDDING.md | Removes obsolete embedding doc (since _code/ is removed). |
Files not reviewed (8)
- .idea/codeStyles/Project.xml: Language not supported
- .idea/copyright/TeamDev_Open_Source.xml: Language not supported
- .idea/dictionaries/common.xml: Language not supported
- .idea/inspectionProfiles/Project_Default.xml: Language not supported
- .idea/live-templates/README.md: Language not supported
- .idea/live-templates/Spine.xml: Language not supported
- .idea/live-templates/User.xml: Language not supported
- .idea/misc.xml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Agent-Logs-Url: https://github.com/SpineEventEngine/SpineEventEngine.github.io/sessions/ef7ec51c-a552-46f5-896e-e5a525b99b51 Co-authored-by: alexander-yevsyukov <3116444+alexander-yevsyukov@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 109 out of 125 changed files in this pull request and generated 4 comments.
Files not reviewed (8)
- .idea/codeStyles/Project.xml: Language not supported
- .idea/copyright/TeamDev_Open_Source.xml: Language not supported
- .idea/dictionaries/common.xml: Language not supported
- .idea/inspectionProfiles/Project_Default.xml: Language not supported
- .idea/live-templates/README.md: Language not supported
- .idea/live-templates/Spine.xml: Language not supported
- .idea/live-templates/User.xml: Language not supported
- .idea/misc.xml: Language not supported
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 109 out of 125 changed files in this pull request and generated 5 comments.
Files not reviewed (8)
- .idea/codeStyles/Project.xml: Language not supported
- .idea/copyright/TeamDev_Open_Source.xml: Language not supported
- .idea/dictionaries/common.xml: Language not supported
- .idea/inspectionProfiles/Project_Default.xml: Language not supported
- .idea/live-templates/README.md: Language not supported
- .idea/live-templates/Spine.xml: Language not supported
- .idea/live-templates/User.xml: Language not supported
- .idea/misc.xml: Language not supported
Comments suppressed due to low confidence (1)
site/layouts/_partials/oss-licenses/licenses.html:61
- The Showdown script is loaded from
cdn.rawgit.com, which has been a deprecated/discontinued CDN for years and can be a reliability risk for the OSS licenses page. Since this page now depends on third-party scripts for sanitization/conversion, consider switching Showdown to a maintained CDN (e.g., npm CDN like jsDelivr/unpkg) and pin it with SRI as well, similar to the DOMPurify include.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 109 out of 125 changed files in this pull request and generated 5 comments.
Files not reviewed (8)
- .idea/codeStyles/Project.xml: Language not supported
- .idea/copyright/TeamDev_Open_Source.xml: Language not supported
- .idea/dictionaries/common.xml: Language not supported
- .idea/inspectionProfiles/Project_Default.xml: Language not supported
- .idea/live-templates/README.md: Language not supported
- .idea/live-templates/Spine.xml: Language not supported
- .idea/live-templates/User.xml: Language not supported
- .idea/misc.xml: Language not supported
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 109 out of 125 changed files in this pull request and generated 3 comments.
Files not reviewed (8)
- .idea/codeStyles/Project.xml: Language not supported
- .idea/copyright/TeamDev_Open_Source.xml: Language not supported
- .idea/dictionaries/common.xml: Language not supported
- .idea/inspectionProfiles/Project_Default.xml: Language not supported
- .idea/live-templates/README.md: Language not supported
- .idea/live-templates/Spine.xml: Language not supported
- .idea/live-templates/User.xml: Language not supported
- .idea/misc.xml: Language not supported
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 109 out of 125 changed files in this pull request and generated 3 comments.
Files not reviewed (8)
- .idea/codeStyles/Project.xml: Language not supported
- .idea/copyright/TeamDev_Open_Source.xml: Language not supported
- .idea/dictionaries/common.xml: Language not supported
- .idea/inspectionProfiles/Project_Default.xml: Language not supported
- .idea/live-templates/README.md: Language not supported
- .idea/live-templates/Spine.xml: Language not supported
- .idea/live-templates/User.xml: Language not supported
- .idea/misc.xml: Language not supported
Resolving the comment #544 (comment)
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.
This PR brings latest version of the Documentation module which brings Validation docs to the site.
Other notable changes
configwas applied to this project, bringing agent-related files.9.5.1.shscript.buildAlltask._codedirectory.