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

clean up minor issues in docs #493

Merged
merged 1 commit into from
Oct 4, 2024
Merged

clean up minor issues in docs #493

merged 1 commit into from
Oct 4, 2024

Conversation

mahf708
Copy link
Contributor

@mahf708 mahf708 commented Oct 4, 2024

Fixes #489

Highlights:

Notes (if applicable):

Summary by Sourcery

Update the GitHub Actions workflow for building and deploying documentation by renaming the workflow and job names, and adjusting the path for the documentation generation script.

CI:

  • Rename the GitHub Actions workflow from 'Build and Deploy Documentation' to 'mkdocs'.
  • Change the job name in the GitHub Actions workflow from 'build-deploy' to 'blds'.
  • Update the path for the Python script in the GitHub Actions workflow to 'docs/mk_generator.py'.

Copy link
Contributor

sourcery-ai bot commented Oct 4, 2024

Reviewer's Guide by Sourcery

This pull request makes minor changes to the documentation workflow file, including renaming the workflow and a job, and updating the path to the documentation generator script.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Rename the documentation workflow and its main job
  • Change workflow name from 'Build and Deploy Documentation' to 'mkdocs'
  • Rename the main job from 'build-deploy' to 'blds'
.github/workflows/mkdocs.yml
Update the path to the documentation generator script
  • Change the path of mk_generator.py from the root directory to the docs directory
.github/workflows/mkdocs.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @mahf708 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider keeping more descriptive names for the workflow and job. 'Build and Deploy Documentation' and 'build-deploy' are clearer than 'mkdocs' and 'blds' respectively.
  • Please provide more context in the PR description about the reasons for these changes. It's not clear how these modifications address the issue mentioned (move mk_generator from root, rename action workflows #489).
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mahf708 mahf708 added this pull request to the merge queue Oct 4, 2024
Merged via the queue into uncscode:main with commit 0edf3e9 Oct 4, 2024
8 checks passed
@mahf708 mahf708 deleted the cleanup branch October 4, 2024 21:58
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.

move mk_generator from root, rename action workflows
2 participants