Skip to content

[CHORE] Refactor docs generation workflow#97

Merged
hadiidbouk merged 1 commit intodevelopfrom
chore/docs-refactor
Jan 29, 2026
Merged

[CHORE] Refactor docs generation workflow#97
hadiidbouk merged 1 commit intodevelopfrom
chore/docs-refactor

Conversation

@hadiidbouk
Copy link
Copy Markdown
Collaborator

Goals ⚽

  • Implement versioned documentation for releases and main branch
  • Enhance documentation UI with Fueled brand colors and logo
  • Refactor documentation workflow into modular scripts
  • Remove develop branch from the documentation deployment triggers

Backwards-compatibility:

No breaking changes. This only affects documentation generation and deployment.

Implementation Details 🚧

  • Moved documentation logic from docs.yml into scripts/docs-script.sh and scripts/deploy-docs.sh
  • Added versioned documentation support: release tags deploy to /v{version}/, main branch deploys to root
  • Updated UI styling with Fueled brand colors
  • Added Fueled logo to documentation index pages with a link to fueled.com
  • Updated workflow to trigger on main branch and tags only (removed develop)
  • Added docs/ to .gitignore to keep generated files out of the main branch
  • Created scripts/ directory for better organization

Additional Notes:

  • Documentation is now automatically generated and deployed on pushes to main and when tags are created

Testing Details 🔍

N/A

- Move documentation logic into scripts/docs-script.sh and scripts/deploy-docs.sh
- Add versioned documentation support (tags deploy to /v{version}/)
- Update UI with Fueled brand colors and logo
- Update workflow to trigger on main branch and tags only
- Add docs/ to .gitignore
Copy link
Copy Markdown
Member

@Sissing Sissing left a comment

Choose a reason for hiding this comment

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

Nice work!

@hadiidbouk hadiidbouk merged commit 6a5d88c into develop Jan 29, 2026
1 check passed
@hadiidbouk hadiidbouk deleted the chore/docs-refactor branch January 29, 2026 12:38
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