Skip to content
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.

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

refs #147: base docs framework polishing #171

Merged
merged 9 commits into from
Mar 11, 2024

Conversation

stickgrinder
Copy link
Collaborator

This PR brings a lot of polishing and introduces a solid and clean deployment procedure. In a nutshell:

  • All the docs-related files (docker files, compose yaml, mkdocs conf, scripts, makefile) have been moved into the docs directory.
  • We now have cleaner docs/src and docs/dist subdirs for source and build+deploy automation. The dist directory should always stay empty, as it's managed by the makefile.
  • DockBlock extraction from code and deployment to gh-pages is working cleanly and has been documented.
  • No configuration required. The whole thing is 100% portable as long as you have Docker and make it available.
  • Overall polishing and renaming of most make targets.

@stickgrinder stickgrinder added the improvement New feature or request label Mar 10, 2024
@stickgrinder stickgrinder added this to the v2.0 - Stable milestone Mar 10, 2024
@stickgrinder stickgrinder requested a review from mapedorr March 10, 2024 20:03
Copy link
Collaborator

@mapedorr mapedorr left a comment

Choose a reason for hiding this comment

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

Everything looks good. All seems like dark magic to me.

@mapedorr mapedorr merged commit 6acb3fb into develop Mar 11, 2024
@mapedorr mapedorr deleted the feature/147-base-framework-polishing branch March 11, 2024 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants