Skip to content

Feat/docs versioning #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
ervcz wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Feat/docs versioning #500

ervcz wants to merge 3 commits into from

Conversation

@ervcz
Copy link
Contributor

@ervcz ervcz commented Nov 10, 2025

This PR implements documentation versioning support for the Flatcar website, allowing us to maintain multiple documentation versions (current and historical snapshots) as part of the website repository itself, rather than relying on external documentation repositories.

Key changes:

  • Removes external documentation fetching mechanism (external_docs in config)
  • Adds local documentation versioning in content/docs/ with date-based snapshots
  • Creates initial documentation snapshot dated 23-10-2025 (pre-OIDC state)
  • Adds documentation versioning guide to README
  • Fixes sidebar overlap on scroll issue

Changes

Documentation Infrastructure

  • Removed external docs support: Eliminates the external_docs configuration that previously pulled documentation from external repositories
  • Added local versioning structure: Documentation versions are now stored directly in content/docs/ with:
    • content/docs/latest/ - current documentation (highest weight)
    • content/docs/DD-MM-YYYY/ - historical snapshots (date when they became outdated)
  • Updated config: Changed github_edit_url to base_github_edit_url to support version-specific edit links

Documentation Content

  • Initial snapshot created: Preserved current documentation state (pre-OIDC) as content/docs/23-10-2025/

UI Fix

  • Fixed sidebar overlap: Resolved scrolling issue where navbar would overlap the version badge

Test Plan

  • Verify documentation renders correctly
  • Confirm version selector works
  • Test GitHub edit links point to correct paths
  • Validate sidebar version label no longer overlaps on scroll with the navbar, navbar hiding it
  • Check that documentation content is accessible at expected URLs

@ervcz ervcz force-pushed the feat/docs-versioning branch 3 times, most recently from 22f922f to 84a1c4b Compare November 10, 2025 11:42
@github-actions
Copy link

github-actions bot commented Nov 10, 2025

Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-500.westeurope.1.azurestaticapps.net

@ervcz ervcz force-pushed the feat/docs-versioning branch from 84a1c4b to 04bce8f Compare November 10, 2025 11:45
@github-actions
Copy link

github-actions bot commented Nov 10, 2025

Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-500.westeurope.1.azurestaticapps.net

1 similar comment
@github-actions
Copy link

github-actions bot commented Nov 10, 2025

Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-500.westeurope.1.azurestaticapps.net

@ervcz ervcz marked this pull request as ready for review November 10, 2025 14:36
@ervcz ervcz requested a review from a team as a code owner November 10, 2025 14:36
@github-actions github-actions bot mentioned this pull request Nov 22, 2025
Closed
ervcz added 3 commits January 12, 2026 14:46
@ervcz
docs: remove external docs support & add target local docs
7eb1588 
- Remove external-docs from .gitignore
- Delete outdated documentation preview instructions from README
- Add documentation for new docs versioning workflow
- Remove external_docs configuration from config.yaml
- Update redirect logic to use local docs structure
- Implement new version ordering system for local docs
- Add getordereddocs partial for version management
- Update config to use base GitHub edit URL instead of hardcoded path
- Simplify edit link logic
- Relocate version selector from standalone component to navigation tree
- Convert select dropdown to Bootstrap dropdown component
- Add Material UI styling to sidebar version selection

Signed-off-by: Ervin Rácz <ervin.racz@protonmail.com>
@ervcz
docs: snapshot pre-OIDC state and fix sidebar overlap on scroll
f22e5ae 
Create documentation snapshot (23-10-2025) for legacy OIDC setup before
Authorization Code Flow + PKCE migration. Add link from current docs to
legacy version for users on older Nebraska versions.

Also fix sidebar title being hidden when navbar shrinks on scroll:
- Add dynamic padding compensation to sidebar when navbar shrinks
- Use shared transition timing variables for smooth animations
- Compensation scalar (0.9) ensures title remains visible
- Simplify docs-section padding to consistent 130px across breakpoints

Signed-off-by: Ervin Rácz <ervin.racz@protonmail.com>
@ervcz
docs: snapshot pre-OIDC state and fix sidebar overlap on scroll
7f644d0 
Create documentation snapshot (23-10-2025) for legacy OIDC setup before
Authorization Code Flow + PKCE migration. Add link from current docs to
legacy version for users on older Nebraska versions.

Also fix sidebar title being hidden when navbar shrinks on scroll:
- Add dynamic padding compensation to sidebar when navbar shrinks
- Use shared transition timing variables for smooth animations
- Compensation scalar (0.9) ensures title remains visible
- Simplify docs-section padding to consistent 130px across breakpoints

Signed-off-by: Ervin Rácz <ervin.racz@protonmail.com>
@ervcz ervcz force-pushed the feat/docs-versioning branch from 3ad3bb5 to 7f644d0 Compare January 12, 2026 12:46
@github-actions
Copy link

github-actions bot commented Jan 12, 2026

Azure Static Web Apps: Your stage site is ready! Visit it here: https://lemon-wave-085522403-500.westeurope.1.azurestaticapps.net

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ervcz