-
-
Notifications
You must be signed in to change notification settings - Fork 2
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
Remove mike versioning #34
Conversation
WalkthroughWalkthroughThe changes reflect a transition from deploying application versions to building project documentation. The GitHub Actions workflow now focuses on using MkDocs instead of Mike for documentation management. This includes the removal of versioning configurations and dependencies related to Mike, simplifying the documentation setup and possibly indicating a new strategy for managing documentation without versioned releases. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub Actions
participant MkDocs
User->>GitHub Actions: Trigger Documentation Build
GitHub Actions->>MkDocs: Build Documentation
MkDocs-->>GitHub Actions: Return Built Documentation
GitHub Actions-->>User: Documentation Build Complete
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
poetry.lock
is excluded by!**/*.lock
Files selected for processing (3)
- .github/workflows/deploy.yaml (1 hunks)
- mkdocs.yml (1 hunks)
- pyproject.toml (1 hunks)
Files skipped from review due to trivial changes (2)
- mkdocs.yml
- pyproject.toml
Additional comments not posted (2)
.github/workflows/deploy.yaml (2)
40-41
: LGTM! MkDocs setup for building documentation is correctly added.The step to build documentation using MkDocs is correctly implemented.
42-44
: LGTM! Artifact upload setup is correctly added.The step to upload the built documentation as artifacts is correctly implemented.
Remove the versioning via Mike, because this still works with a separate branch and unfortunately I can't get that to work.
Summary by CodeRabbit
New Features
Bug Fixes
Chores
mike
package to simplify documentation management.