Skip to content

Update the documentation module and drop .lycheeignore - #565

Merged
alexander-yevsyukov merged 2 commits into
masterfrom
claude/documentation-update-129f7f
Nov 2, 2026
Merged

alexander-yevsyukov merged 2 commits into
masterfrom
claude/documentation-update-129f7f

Conversation

@alexander-yevsyukov

Copy link
Copy Markdown
Contributor

Updates the github.com/SpineEventEngine/documentation/docs Hugo module from 3045fa4 to 3346b3f, the merge of SpineEventEngine/documentation#98. It brings in:

Go's minimum version selection also moves validation/docs from 6465029 to 2754355, the version documentation now requires. site-commons and the npm packages stay where they are.

.lycheeignore

#564 added .lycheeignore with 9 patterns for links broken in the imported docs. All 9 now pass, so this PR deletes the file. I ran Lychee 0.24.2 with lychee.toml over the development build, from a directory with no .lycheeignore, so every pattern's link got checked:

  • 0 errors, 14,663 links (173 excluded by lychee.toml).
  • None of the 8 absolute URLs appears in the rendered pages anymore.
  • The 3 relative links resolve inside the site now: /docs/validation/developer/… and /docs/validation/user/05-custom-validation/typical_custom_option.jpg, which returns 200.

check-links.yml keeps its - '.lycheeignore' trigger. It comes from config (SpineEventEngine/config#826), and a site may need the file again later.

Verification

  • hugo --minify with an empty resource directory, so Sass compiles from scratch: no warnings.
  • npm test in site/: 42 tests pass.
  • Lychee from the repo root, as CI runs it: 0 errors.

🤖 Generated with Claude Code

Brings in SpineEventEngine/documentation#96 and #98. They fix the Stack
Overflow link and, through SpineEventEngine/validation#341, the eight
broken links in the validation docs. Lychee now passes on all nine links
without the ignore file, so the file goes. `check-links.yml` keeps its
`.lycheeignore` trigger, which comes from `config`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 2, 2026 18:36
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-02T18:38:16.917549Z 203c039 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved

No active review issues block the documentation dependency updates and removal of link-check exclusions.

No open issues 🎉

What changed in this PR

Updates the site’s imported documentation to include upstream link fixes, allowing removal of the temporary Lychee exclusions introduced in #564.

Changes:

  • Advances documentation/docs to 3346b3f and its validation/docs dependency to 2754355.
  • Adds checksums for both updated modules.
  • Deletes .lycheeignore now that the affected links are fixed; theme and npm dependencies remain unchanged.
File Description
site/​go.sum Adds checksums for the updated documentation modules.
site/​go.mod Updates documentation and validation module versions.
.lycheeignore Removes obsolete exclusions for broken documentation links.

Review effort: Balanced

Brings in SpineEventEngine/config#826 and #827. #826 adds the
`.lycheeignore` trigger to `check-links.yml`, which this repo's copy
already has. #827 makes `Check Links` also find Hugo configs under
`_preview/`. This repo's copy doesn't have that yet, and doesn't need it:
the site's config is in `site/config/_default/`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@alexander-yevsyukov alexander-yevsyukov self-assigned this Nov 2, 2026
@alexander-yevsyukov alexander-yevsyukov moved this to In Review in v2.0 Nov 2, 2026
@alexander-yevsyukov
alexander-yevsyukov merged commit feb4726 into master Nov 2, 2026
4 checks passed
@alexander-yevsyukov
alexander-yevsyukov deleted the claude/documentation-update-129f7f branch November 2, 2026 18:56
@github-project-automation github-project-automation Bot moved this from In Review to ✅ Done in v2.0 Nov 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants