Skip to content

Conversation

@fm3
Copy link
Member

@fm3 fm3 commented Nov 26, 2025

The content of the docs dir is passed to mkdocs in the libs CI. There was a dead symlink there now after #9090 blocking libs CI runs.

@fm3 fm3 self-assigned this Nov 26, 2025
@fm3 fm3 requested a review from philippotto November 26, 2025 09:30
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 26, 2025

📝 Walkthrough

Walkthrough

This PR reorganizes documentation structure by removing the evolutions documentation from the conf/ directory and introducing a new schema/ directory. The changes represent a structural migration of documentation files to a new location.

Changes

Cohort / File(s) Summary
Documentation restructuring
docs/conf/evolutions, docs/schema/
Deletion of evolutions file from conf directory and creation of new schema directory reference, indicating documentation reorganization from conf to schema paths

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Directory and file reorganization with no logic changes
  • Straightforward structural migration of documentation files

Possibly related PRs

  • PR #9090: Relocates schema/evolutions files from conf/evolutions to schema/evolutions structure
  • PR #9037: Modifies references targeting the conf/evolutions path being deleted

Suggested labels

infrastructure

Suggested reviewers

  • normanrz
  • philippotto

Poem

🐰 Hopping through the docs so neat,
Files reorganized, paths complete,
From conf to schema, a fresh new way,
Evolutions bloom in the light of day! 🌱

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adapting a symlink in docs to reference a new schema directory, which aligns with the PR's objective of fixing a dead symlink.
Description check ✅ Passed The description explains the context and reason for the change—fixing a dead symlink in docs that was blocking CI runs—and is directly related to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-link

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 94a7bd2 and c782cb3.

📒 Files selected for processing (2)
  • docs/conf/evolutions (0 hunks)
  • docs/schema (1 hunks)
💤 Files with no reviewable changes (1)
  • docs/conf/evolutions
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: frontend-tests
  • GitHub Check: build-smoketest-push
  • GitHub Check: backend-tests
🔇 Additional comments (1)
docs/schema (1)

1-1: Symlink is valid and correctly resolves to the target directory.

Verification confirms the symlink at docs/schema is properly configured:

  • Target ../schema/ is correct and resolves to the repository root's schema/ directory
  • The target directory exists and contains schema documentation (schema.sql and evolutions/ subdirectory)
  • Symlink enables mkdocs CI to access documentation as intended

The fix successfully resolves the dead symlink issue from PR #9090.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@fm3 fm3 enabled auto-merge (squash) November 26, 2025 10:49
@fm3 fm3 merged commit 2079a18 into master Nov 26, 2025
5 checks passed
@fm3 fm3 deleted the docs-link branch November 26, 2025 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants