Skip to content

Implement version-specific MkDocs configuration for v0 and v1 documentation - #9

Merged
gabriellewp merged 2 commits into
mkdocsfrom
copilot/update-mkdocs-version-dropdown
Jun 13, 2026
Merged

Implement version-specific MkDocs configuration for v0 and v1 documentation#9
gabriellewp merged 2 commits into
mkdocsfrom
copilot/update-mkdocs-version-dropdown

Conversation

Copilot AI commented Apr 21, 2026

Copy link
Copy Markdown
Contributor

The v0 and v1 documentation dropdown links were displaying identical content regardless of selection. This PR implements separate MkDocs configurations to properly reflect version differences: v0 (AnnoRank) excludes XAI pages while v1 (XAnnoRank) includes them.

Changes

  • New mkdocs-v0.yml configuration: Stripped-down v0 config with navigation excluding XAI pages (XAI Configuration, XAI Ranking App, XAI UI Functionalities)
  • Updated mkdocs.yml: Explicit navigation structure for v1 that includes all XAI-related pages
  • Updated deploy workflow: Modified .github/workflows/deploy-docs.yml to use --config-file mkdocs-v0.yml during v0 build and deploy steps
  • Added gh-pages sync: Integrated gh-pages branch synchronization to prevent concurrent push conflicts during dual-version deployments

Example

The workflow now correctly builds each version:

# For v0 (AnnoRank)
- name: Build site
  run: mkdocs build --config-file mkdocs-v0.yml

# For v1 (XAnnoRank) 
- name: Build site
  run: mkdocs build  # Uses default mkdocs.yml with XAI content

When users select v0 from the dropdown, they see AnnoRank docs without XAI. Selecting v1 shows XAnnoRank docs with full XAI support.

…yml (v1, with XAI nav), update workflow to use mkdocs-v0.yml for v0 build
Copilot AI force-pushed the copilot/update-mkdocs-version-dropdown branch from c3eb002 to f721355 Compare June 12, 2026 18:49
Copilot AI changed the title Deploy version-specific mkdocs configs to mkdocs branch Implement version-specific MkDocs configurations for v0/v1 documentation builds Jun 12, 2026
Copilot AI changed the title Implement version-specific MkDocs configurations for v0/v1 documentation builds Implement version-specific MkDocs configuration for v0 and v1 documentation Jun 12, 2026
@gabriellewp
gabriellewp changed the base branch from main to mkdocs June 13, 2026 17:52
@gabriellewp
gabriellewp marked this pull request as ready for review June 13, 2026 17:52
@gabriellewp
gabriellewp merged commit 9f2af72 into mkdocs Jun 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants